Serialized Form

Package org.hl7.fhir.r4.elementmodel

Class org.hl7.fhir.r4.elementmodel.Element

class Element extends Base implements Serializable

Serialized Fields

children

List<Element> children

col

int col

comments

List<String> comments

elementProperty

Property elementProperty

explicitType

String explicitType

index

int index

line

int line

name

String name

property

Property property

special

Element.SpecialElement special

type

String type

value

String value

xhtml

org.hl7.fhir.utilities.xhtml.XhtmlNode xhtml

Package org.hl7.fhir.r4.fhirpath

Exception Class org.hl7.fhir.r4.fhirpath.FHIRLexer.FHIRLexerException

class FHIRLexerException extends org.hl7.fhir.exceptions.FHIRException implements Serializable

Class org.hl7.fhir.r4.fhirpath.FHIRPathUtilityClasses.ClassTypeInfo

class ClassTypeInfo extends Base implements Serializable

serialVersionUID:

4909223114071029317L

Serialized Fields

instance

Base instance

Class org.hl7.fhir.r4.fhirpath.FHIRPathUtilityClasses.FHIRConstant

class FHIRConstant extends Base implements Serializable

serialVersionUID:

-8933773658248269439L

Serialized Fields

value

String value

Package org.hl7.fhir.r4.model

Class org.hl7.fhir.r4.model.Account

class Account extends DomainResource implements Serializable

serialVersionUID:

1211238069L

Serialized Fields

coverage

List<Account.CoverageComponent> coverage

The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.

description

StringType description

Provides additional information about what the account tracks and how it is used.

guarantor

List<Account.GuarantorComponent> guarantor

The parties responsible for balancing the account if other payment options fall short.

identifier

List<Identifier> identifier

Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number).

name

StringType name

Name used for the account when displaying it to humans in reports, etc.

owner

Reference owner

Indicates the service area, hospital, department, etc. with responsibility for managing the Account.

ownerTarget

Organization ownerTarget

The actual object that is the target of the reference (Indicates the service area, hospital, department, etc. with responsibility for managing the Account.)

partOf

Reference partOf

Reference to a parent Account.

partOfTarget

Account partOfTarget

The actual object that is the target of the reference (Reference to a parent Account.)

servicePeriod

Period servicePeriod

The date range of services associated with this account.

status

Enumeration<Account.AccountStatus> status

Indicates whether the account is presently used/usable or not.

subject

List<Reference> subject

Identifies the entity which incurs the expenses. While the immediate recipients of services or goods might be entities related to the subject, the expenses were ultimately incurred by the subject of the Account.

subjectTarget

List<Resource> subjectTarget

The actual objects that are the target of the reference (Identifies the entity which incurs the expenses. While the immediate recipients of services or goods might be entities related to the subject, the expenses were ultimately incurred by the subject of the Account.)

type

CodeableConcept type

Categorizes the account for reporting and searching purposes.

Class org.hl7.fhir.r4.model.Account.AccountStatusEnumFactory

class AccountStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Account.CoverageComponent

class CoverageComponent extends BackboneElement implements Serializable

serialVersionUID:

-1046265008L

Serialized Fields

coverage

Reference coverage

The party(s) that contribute to payment (or part of) of the charges applied to this account (including self-pay). A coverage may only be responsible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing.

coverageTarget

Coverage coverageTarget

The actual object that is the target of the reference (The party(s) that contribute to payment (or part of) of the charges applied to this account (including self-pay). A coverage may only be responsible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing.)

priority

PositiveIntType priority

The priority of the coverage in the context of this account.

Class org.hl7.fhir.r4.model.Account.GuarantorComponent

class GuarantorComponent extends BackboneElement implements Serializable

serialVersionUID:

-1012345396L

Serialized Fields

onHold

BooleanType onHold

A guarantor may be placed on credit hold or otherwise have their role temporarily suspended.

party

Reference party

The entity who is responsible.

partyTarget

Resource partyTarget

The actual object that is the target of the reference (The entity who is responsible.)

period

Period period

The timeframe during which the guarantor accepts responsibility for the account.

Class org.hl7.fhir.r4.model.ActivityDefinition

class ActivityDefinition extends MetadataResource implements Serializable

serialVersionUID:

1488459022L

Serialized Fields

approvalDate

DateType approvalDate

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

author

List<ContactDetail> author

An individiual or organization primarily involved in the creation and maintenance of the content.

bodySite

List<CodeableConcept> bodySite

Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).

code

CodeableConcept code

Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.

copyright

MarkdownType copyright

A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.

doNotPerform

BooleanType doNotPerform

Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.

dosage

List<Dosage> dosage

Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.

dynamicValue

List<ActivityDefinition.ActivityDefinitionDynamicValueComponent> dynamicValue

Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.

editor

List<ContactDetail> editor

An individual or organization primarily responsible for internal coherence of the content.

effectivePeriod

Period effectivePeriod

The period during which the activity definition content was or is planned to be in active use.

endorser

List<ContactDetail> endorser

An individual or organization responsible for officially endorsing the content for use in some setting.

identifier

List<Identifier> identifier

A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

intent

Enumeration<ActivityDefinition.RequestIntent> intent

Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.

kind

Enumeration<ActivityDefinition.ActivityDefinitionKind> kind

A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.

lastReviewDate

DateType lastReviewDate

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

library

List<CanonicalType> library

A reference to a Library resource containing any formal logic used by the activity definition.

location

Reference location

Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.

locationTarget

Location locationTarget

The actual object that is the target of the reference (Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)

observationRequirement

List<Reference> observationRequirement

Defines observation requirements for the action to be performed, such as body weight or surface area.

observationRequirementTarget

List<ObservationDefinition> observationRequirementTarget

The actual objects that are the target of the reference (Defines observation requirements for the action to be performed, such as body weight or surface area.)

observationResultRequirement

List<Reference> observationResultRequirement

Defines the observations that are expected to be produced by the action.

observationResultRequirementTarget

List<ObservationDefinition> observationResultRequirementTarget

The actual objects that are the target of the reference (Defines the observations that are expected to be produced by the action.)

participant

List<ActivityDefinition.ActivityDefinitionParticipantComponent> participant

Indicates who should participate in performing the action described.

priority

Enumeration<ActivityDefinition.RequestPriority> priority

Indicates how quickly the activity should be addressed with respect to other requests.

product

Type product

Identifies the food, drug or other product being consumed or supplied in the activity.

profile

CanonicalType profile

A profile to which the target of the activity definition is expected to conform.

purpose

MarkdownType purpose

Explanation of why this activity definition is needed and why it has been designed as it has.

quantity

Quantity quantity

Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).

relatedArtifact

List<RelatedArtifact> relatedArtifact

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

reviewer

List<ContactDetail> reviewer

An individual or organization primarily responsible for review of some aspect of the content.

specimenRequirement

List<Reference> specimenRequirement

Defines specimen requirements for the action to be performed, such as required specimens for a lab test.

specimenRequirementTarget

List<SpecimenDefinition> specimenRequirementTarget

The actual objects that are the target of the reference (Defines specimen requirements for the action to be performed, such as required specimens for a lab test.)

subject

Type subject

A code or group definition that describes the intended subject of the activity being defined.

subtitle

StringType subtitle

An explanatory or alternate title for the activity definition giving additional information about its content.

timing

Type timing

The period, timing or frequency upon which the described activity is to occur.

topic

List<CodeableConcept> topic

Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.

transform

CanonicalType transform

A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

usage

StringType usage

A detailed description of how the activity definition is used from a clinical perspective.

Class org.hl7.fhir.r4.model.ActivityDefinition.ActivityDefinitionDynamicValueComponent

class ActivityDefinitionDynamicValueComponent extends BackboneElement implements Serializable

serialVersionUID:

1064529082L

Serialized Fields

expression

Expression expression

An expression specifying the value of the customized element.

path

StringType path

The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).

Class org.hl7.fhir.r4.model.ActivityDefinition.ActivityDefinitionKindEnumFactory

class ActivityDefinitionKindEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ActivityDefinition.ActivityDefinitionParticipantComponent

class ActivityDefinitionParticipantComponent extends BackboneElement implements Serializable

serialVersionUID:

-1450932564L

Serialized Fields

role

CodeableConcept role

The role the participant should play in performing the described action.

type

Enumeration<ActivityDefinition.ActivityParticipantType> type

The type of participant in the action.

Class org.hl7.fhir.r4.model.ActivityDefinition.ActivityParticipantTypeEnumFactory

class ActivityParticipantTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ActivityDefinition.RequestIntentEnumFactory

class RequestIntentEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ActivityDefinition.RequestPriorityEnumFactory

class RequestPriorityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Address

class Address extends Type implements Serializable

serialVersionUID:

561490318L

Serialized Fields

city

StringType city

The name of the city, town, suburb, village or other community or delivery center.

country

StringType country

Country - a nation as commonly understood or generally accepted.

district

StringType district

The name of the administrative area (county).

line

List<StringType> line

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

period

Period period

Time period when address was/is in use.

postalCode

StringType postalCode

A postal code designating a region defined by the postal service.

state

StringType state

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

text

StringType text

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

type

Enumeration<Address.AddressType> type

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

use

Enumeration<Address.AddressUse> use

The purpose of this address.

Class org.hl7.fhir.r4.model.Address.AddressTypeEnumFactory

class AddressTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Address.AddressUseEnumFactory

class AddressUseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.AdverseEvent

class AdverseEvent extends DomainResource implements Serializable

serialVersionUID:

-2055195281L

Serialized Fields

actuality

Enumeration<AdverseEvent.AdverseEventActuality> actuality

Whether the event actually happened, or just had the potential to. Note that this is independent of whether anyone was affected or harmed or how severely.

category

List<CodeableConcept> category

The overall type of event, intended for search and filtering purposes.

contributor

List<Reference> contributor

Parties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness).

contributorTarget

List<Resource> contributorTarget

The actual objects that are the target of the reference (Parties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness).)

date

DateTimeType date

The date (and perhaps time) when the adverse event occurred.

detected

DateTimeType detected

Estimated or actual date the AdverseEvent began, in the opinion of the reporter.

encounter

Reference encounter

The Encounter during which AdverseEvent was created or to which the creation of this record is tightly associated.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (The Encounter during which AdverseEvent was created or to which the creation of this record is tightly associated.)

event

CodeableConcept event

This element defines the specific type of event that occurred or that was prevented from occurring.

identifier

Identifier identifier

Business identifiers assigned to this adverse event by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

location

Reference location

The information about where the adverse event occurred.

locationTarget

Location locationTarget

The actual object that is the target of the reference (The information about where the adverse event occurred.)

outcome

CodeableConcept outcome

Describes the type of outcome from the adverse event.

recordedDate

DateTimeType recordedDate

The date on which the existence of the AdverseEvent was first recorded.

recorder

Reference recorder

Information on who recorded the adverse event. May be the patient or a practitioner.

recorderTarget

Resource recorderTarget

The actual object that is the target of the reference (Information on who recorded the adverse event. May be the patient or a practitioner.)

referenceDocument

List<Reference> referenceDocument

AdverseEvent.referenceDocument.

referenceDocumentTarget

List<DocumentReference> referenceDocumentTarget

The actual objects that are the target of the reference (AdverseEvent.referenceDocument.)

resultingCondition

List<Reference> resultingCondition

Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).

resultingConditionTarget

List<Condition> resultingConditionTarget

The actual objects that are the target of the reference (Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).)

seriousness

CodeableConcept seriousness

Assessment whether this event was of real importance.

severity

CodeableConcept severity

Describes the severity of the adverse event, in relation to the subject. Contrast to AdverseEvent.seriousness - a severe rash might not be serious, but a mild heart problem is.

study

List<Reference> study

AdverseEvent.study.

studyTarget

List<ResearchStudy> studyTarget

The actual objects that are the target of the reference (AdverseEvent.study.)

subject

Reference subject

This subject or group impacted by the event.

subjectMedicalHistory

List<Reference> subjectMedicalHistory

AdverseEvent.subjectMedicalHistory.

subjectMedicalHistoryTarget

List<Resource> subjectMedicalHistoryTarget

The actual objects that are the target of the reference (AdverseEvent.subjectMedicalHistory.)

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (This subject or group impacted by the event.)

suspectEntity

List<AdverseEvent.AdverseEventSuspectEntityComponent> suspectEntity

Describes the entity that is suspected to have caused the adverse event.

Class org.hl7.fhir.r4.model.AdverseEvent.AdverseEventActualityEnumFactory

class AdverseEventActualityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.AdverseEvent.AdverseEventSuspectEntityCausalityComponent

class AdverseEventSuspectEntityCausalityComponent extends BackboneElement implements Serializable

serialVersionUID:

-1847234837L

Serialized Fields

assessment

CodeableConcept assessment

Assessment of if the entity caused the event.

author

Reference author

AdverseEvent.suspectEntity.causalityAuthor.

authorTarget

Resource authorTarget

The actual object that is the target of the reference (AdverseEvent.suspectEntity.causalityAuthor.)

method

CodeableConcept method

ProbabilityScale | Bayesian | Checklist.

productRelatedness

StringType productRelatedness

AdverseEvent.suspectEntity.causalityProductRelatedness.

Class org.hl7.fhir.r4.model.AdverseEvent.AdverseEventSuspectEntityComponent

class AdverseEventSuspectEntityComponent extends BackboneElement implements Serializable

serialVersionUID:

1245759325L

Serialized Fields

causality

List<AdverseEvent.AdverseEventSuspectEntityCausalityComponent> causality

Information on the possible cause of the event.

instance

Reference instance

Identifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device.

instanceTarget

Resource instanceTarget

The actual object that is the target of the reference (Identifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device.)

Class org.hl7.fhir.r4.model.Age

class Age extends Quantity implements Serializable

serialVersionUID:

0L

Class org.hl7.fhir.r4.model.AllergyIntolerance

class AllergyIntolerance extends DomainResource implements Serializable

serialVersionUID:

393192289L

Serialized Fields

asserter

Reference asserter

The source of the information about the allergy that is recorded.

asserterTarget

Resource asserterTarget

The actual object that is the target of the reference (The source of the information about the allergy that is recorded.)

category

List<Enumeration<AllergyIntolerance.AllergyIntoleranceCategory>> category

Category of the identified substance.

clinicalStatus

CodeableConcept clinicalStatus

The clinical status of the allergy or intolerance.

code

CodeableConcept code

Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"), or a negated/excluded code for a specific substance or class (e.g., "No latex allergy") or a general or categorical negated statement (e.g., "No known allergy", "No known drug allergies"). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.

criticality

Enumeration<AllergyIntolerance.AllergyIntoleranceCriticality> criticality

Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.

encounter

Reference encounter

The encounter when the allergy or intolerance was asserted.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (The encounter when the allergy or intolerance was asserted.)

identifier

List<Identifier> identifier

Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

lastOccurrence

DateTimeType lastOccurrence

Represents the date and/or time of the last known occurrence of a reaction event.

note

List<Annotation> note

Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.

onset

Type onset

Estimated or actual date, date-time, or age when allergy or intolerance was identified.

patient

Reference patient

The patient who has the allergy or intolerance.

patientTarget

Patient patientTarget

The actual object that is the target of the reference (The patient who has the allergy or intolerance.)

reaction

List<AllergyIntolerance.AllergyIntoleranceReactionComponent> reaction

Details about each adverse reaction event linked to exposure to the identified substance.

recordedDate

DateTimeType recordedDate

The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.

recorder

Reference recorder

Individual who recorded the record and takes responsibility for its content.

recorderTarget

Resource recorderTarget

The actual object that is the target of the reference (Individual who recorded the record and takes responsibility for its content.)

type

Enumeration<AllergyIntolerance.AllergyIntoleranceType> type

Identification of the underlying physiological mechanism for the reaction risk.

verificationStatus

CodeableConcept verificationStatus

Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).

Class org.hl7.fhir.r4.model.AllergyIntolerance.AllergyIntoleranceCategoryEnumFactory

class AllergyIntoleranceCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.AllergyIntolerance.AllergyIntoleranceCriticalityEnumFactory

class AllergyIntoleranceCriticalityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.AllergyIntolerance.AllergyIntoleranceReactionComponent

class AllergyIntoleranceReactionComponent extends BackboneElement implements Serializable

serialVersionUID:

-752118516L

Serialized Fields

description

StringType description

Text description about the reaction as a whole, including details of the manifestation if required.

exposureRoute

CodeableConcept exposureRoute

Identification of the route by which the subject was exposed to the substance.

manifestation

List<CodeableConcept> manifestation

Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.

note

List<Annotation> note

Additional text about the adverse reaction event not captured in other fields.

onset

DateTimeType onset

Record of the date and/or time of the onset of the Reaction.

severity

Enumeration<AllergyIntolerance.AllergyIntoleranceSeverity> severity

Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.

substance

CodeableConcept substance

Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.

Class org.hl7.fhir.r4.model.AllergyIntolerance.AllergyIntoleranceSeverityEnumFactory

class AllergyIntoleranceSeverityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.AllergyIntolerance.AllergyIntoleranceTypeEnumFactory

class AllergyIntoleranceTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Annotation

class Annotation extends Type implements Serializable

serialVersionUID:

1324090545L

Serialized Fields

author

Type author

The individual responsible for making the annotation.

text

MarkdownType text

The text of the annotation in markdown format.

time

DateTimeType time

Indicates when this particular annotation was made.

Class org.hl7.fhir.r4.model.Appointment

class Appointment extends DomainResource implements Serializable

serialVersionUID:

-1096822339L

Serialized Fields

appointmentType

CodeableConcept appointmentType

The style of appointment or patient that has been booked in the slot (not service type).

basedOn

List<Reference> basedOn

The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).

basedOnTarget

List<ServiceRequest> basedOnTarget

The actual objects that are the target of the reference (The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).)

cancelationReason

CodeableConcept cancelationReason

The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.

comment

StringType comment

Additional comments about the appointment.

created

DateTimeType created

The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.

description

StringType description

The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.

end

InstantType end

Date/Time that the appointment is to conclude.

identifier

List<Identifier> identifier

This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

minutesDuration

PositiveIntType minutesDuration

Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.

participant

List<Appointment.AppointmentParticipantComponent> participant

List of participants involved in the appointment.

patientInstruction

StringType patientInstruction

While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).

priority

UnsignedIntType priority

The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).

reasonCode

List<CodeableConcept> reasonCode

The coded reason that this appointment is being scheduled. This is more clinical than administrative.

reasonReference

List<Reference> reasonReference

Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.

reasonReferenceTarget

List<Resource> reasonReferenceTarget

The actual objects that are the target of the reference (Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.)

requestedPeriod

List<Period> requestedPeriod

A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.

serviceCategory

List<CodeableConcept> serviceCategory

A broad categorization of the service that is to be performed during this appointment.

serviceType

List<CodeableConcept> serviceType

The specific service that is to be performed during this appointment.

slot

List<Reference> slot

The slots from the participants' schedules that will be filled by the appointment.

slotTarget

List<Slot> slotTarget

The actual objects that are the target of the reference (The slots from the participants' schedules that will be filled by the appointment.)

specialty

List<CodeableConcept> specialty

The specialty of a practitioner that would be required to perform the service requested in this appointment.

start

InstantType start

Date/Time that the appointment is to take place.

status

Enumeration<Appointment.AppointmentStatus> status

The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.

supportingInformation

List<Reference> supportingInformation

Additional information to support the appointment provided when making the appointment.

supportingInformationTarget

List<Resource> supportingInformationTarget

The actual objects that are the target of the reference (Additional information to support the appointment provided when making the appointment.)

Class org.hl7.fhir.r4.model.Appointment.AppointmentParticipantComponent

class AppointmentParticipantComponent extends BackboneElement implements Serializable

serialVersionUID:

-1939292177L

Serialized Fields

actor

Reference actor

A Person, Location/HealthcareService or Device that is participating in the appointment.

actorTarget

Resource actorTarget

The actual object that is the target of the reference (A Person, Location/HealthcareService or Device that is participating in the appointment.)

period

Period period

Participation period of the actor.

required

Enumeration<Appointment.ParticipantRequired> required

Whether this participant is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.

status

Enumeration<Appointment.ParticipationStatus> status

Participation status of the actor.

type

List<CodeableConcept> type

Role of participant in the appointment.

Class org.hl7.fhir.r4.model.Appointment.AppointmentStatusEnumFactory

class AppointmentStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Appointment.ParticipantRequiredEnumFactory

class ParticipantRequiredEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Appointment.ParticipationStatusEnumFactory

class ParticipationStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.AppointmentResponse

class AppointmentResponse extends DomainResource implements Serializable

serialVersionUID:

248548635L

Serialized Fields

actor

Reference actor

A Person, Location, HealthcareService, or Device that is participating in the appointment.

actorTarget

Resource actorTarget

The actual object that is the target of the reference (A Person, Location, HealthcareService, or Device that is participating in the appointment.)

appointment

Reference appointment

Appointment that this response is replying to.

appointmentTarget

Appointment appointmentTarget

The actual object that is the target of the reference (Appointment that this response is replying to.)

comment

StringType comment

Additional comments about the appointment.

end

InstantType end

This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.

identifier

List<Identifier> identifier

This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate.

participantStatus

Enumeration<AppointmentResponse.ParticipantStatus> participantStatus

Participation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.

participantType

List<CodeableConcept> participantType

Role of participant in the appointment.

start

InstantType start

Date/Time that the appointment is to take place, or requested new start time.

Class org.hl7.fhir.r4.model.AppointmentResponse.ParticipantStatusEnumFactory

class ParticipantStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Attachment

class Attachment extends Type implements Serializable

serialVersionUID:

-564352571L

Serialized Fields

contentType

CodeType contentType

Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

creation

DateTimeType creation

The date that the attachment was first created.

data

Base64BinaryType data

The actual data of the attachment - a sequence of bytes, base64 encoded.

hash

Base64BinaryType hash

The calculated hash of the data using SHA-1. Represented using base64.

language

CodeType language

The human language of the content. The value can be any valid value according to BCP 47.

size

UnsignedIntType size

The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

title

StringType title

A label or set of text to display in place of the data.

url

UrlType url

A location where the data can be accessed.

Class org.hl7.fhir.r4.model.AuditEvent

class AuditEvent extends DomainResource implements Serializable

serialVersionUID:

106433685L

Serialized Fields

action

Enumeration<AuditEvent.AuditEventAction> action

Indicator for type of action performed during the event that generated the audit.

agent

List<AuditEvent.AuditEventAgentComponent> agent

An actor taking an active role in the event or activity that is logged.

entity

List<AuditEvent.AuditEventEntityComponent> entity

Specific instances of data or objects that have been accessed.

outcome

Enumeration<AuditEvent.AuditEventOutcome> outcome

Indicates whether the event succeeded or failed.

outcomeDesc

StringType outcomeDesc

A free text description of the outcome of the event.

period

Period period

The period during which the activity occurred.

purposeOfEvent

List<CodeableConcept> purposeOfEvent

The purposeOfUse (reason) that was used during the event being recorded.

recorded

InstantType recorded

The time when the event was recorded.

source

AuditEvent.AuditEventSourceComponent source

The system that is reporting the event.

subtype

List<Coding> subtype

Identifier for the category of event.

type

Coding type

Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function.

Class org.hl7.fhir.r4.model.AuditEvent.AuditEventActionEnumFactory

class AuditEventActionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.AuditEvent.AuditEventAgentComponent

class AuditEventAgentComponent extends BackboneElement implements Serializable

serialVersionUID:

-957410638L

Serialized Fields

altId

StringType altId

Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available.

location

Reference location

Where the event occurred.

locationTarget

Location locationTarget

The actual object that is the target of the reference (Where the event occurred.)

media

Coding media

Type of media involved. Used when the event is about exporting/importing onto media.

name

StringType name

Human-meaningful name for the agent.

network

AuditEvent.AuditEventAgentNetworkComponent network

Logical network location for application activity, if the activity has a network location.

policy

List<UriType> policy

The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.

purposeOfUse

List<CodeableConcept> purposeOfUse

The reason (purpose of use), specific to this agent, that was used during the event being recorded.

requestor

BooleanType requestor

Indicator that the user is or is not the requestor, or initiator, for the event being audited.

role

List<CodeableConcept> role

The security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.

type

CodeableConcept type

Specification of the participation type the user plays when performing the event.

who

Reference who

Reference to who this agent is that was involved in the event.

whoTarget

Resource whoTarget

The actual object that is the target of the reference (Reference to who this agent is that was involved in the event.)

Class org.hl7.fhir.r4.model.AuditEvent.AuditEventAgentNetworkComponent

class AuditEventAgentNetworkComponent extends BackboneElement implements Serializable

serialVersionUID:

-160715924L

Serialized Fields

address

StringType address

An identifier for the network access point of the user device for the audit event.

type

Enumeration<AuditEvent.AuditEventAgentNetworkType> type

An identifier for the type of network access point that originated the audit event.

Class org.hl7.fhir.r4.model.AuditEvent.AuditEventAgentNetworkTypeEnumFactory

class AuditEventAgentNetworkTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.AuditEvent.AuditEventEntityComponent

class AuditEventEntityComponent extends BackboneElement implements Serializable

serialVersionUID:

334545686L

Serialized Fields

description

StringType description

Text that describes the entity in more detail.

detail

List<AuditEvent.AuditEventEntityDetailComponent> detail

Tagged value pairs for conveying additional information about the entity.

lifecycle

Coding lifecycle

Identifier for the data life-cycle stage for the entity.

name

StringType name

A name of the entity in the audit event.

query

Base64BinaryType query

The query parameters for a query-type entities.

role

Coding role

Code representing the role the entity played in the event being audited.

securityLabel

List<Coding> securityLabel

Security labels for the identified entity.

type

Coding type

The type of the object that was involved in this audit event.

what

Reference what

Identifies a specific instance of the entity. The reference should be version specific.

whatTarget

Resource whatTarget

The actual object that is the target of the reference (Identifies a specific instance of the entity. The reference should be version specific.)

Class org.hl7.fhir.r4.model.AuditEvent.AuditEventEntityDetailComponent

class AuditEventEntityDetailComponent extends BackboneElement implements Serializable

serialVersionUID:

-1035059584L

Serialized Fields

type

StringType type

The type of extra detail provided in the value.

value

Type value

The value of the extra detail.

Class org.hl7.fhir.r4.model.AuditEvent.AuditEventOutcomeEnumFactory

class AuditEventOutcomeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.AuditEvent.AuditEventSourceComponent

class AuditEventSourceComponent extends BackboneElement implements Serializable

serialVersionUID:

2133038564L

Serialized Fields

observer

Reference observer

Identifier of the source where the event was detected.

observerTarget

Resource observerTarget

The actual object that is the target of the reference (Identifier of the source where the event was detected.)

site

StringType site

Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group.

type

List<Coding> type

Code specifying the type of source where event originated.

Class org.hl7.fhir.r4.model.BackboneElement

class BackboneElement extends Element implements Serializable

serialVersionUID:

-1431673179L

Serialized Fields

modifierExtension

List<Extension> modifierExtension

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Class org.hl7.fhir.r4.model.BackboneType

class BackboneType extends Type implements Serializable

serialVersionUID:

-1431673179L

Serialized Fields

modifierExtension

List<Extension> modifierExtension

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Class org.hl7.fhir.r4.model.Base

class Base extends Object implements Serializable

Serialized Fields

formatCommentsPost

List<String> formatCommentsPost

Round tracking xml comments for testing convenience

formatCommentsPre

List<String> formatCommentsPre

Round tracking xml comments for testing convenience

userData

Map<String,Object> userData

User appended data items - allow users to add extra information to the class

Class org.hl7.fhir.r4.model.Base64BinaryType

class Base64BinaryType extends PrimitiveType<byte[]> implements Externalizable

serialVersionUID:

3L

Serialization Methods

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Throws:

IOException

Class org.hl7.fhir.r4.model.BaseBinary

class BaseBinary extends Resource implements Serializable

serialVersionUID:

1L

Class org.hl7.fhir.r4.model.BaseDateTimeType

class BaseDateTimeType extends PrimitiveType<Date> implements Externalizable

serialVersionUID:

1L

Serialization Methods

readExternal

public void readExternal(ObjectInput theIn)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput theOut)
                   throws IOException

Throws:

IOException

Class org.hl7.fhir.r4.model.BaseExtension

class BaseExtension extends Type implements Serializable

serialVersionUID:

1L

Class org.hl7.fhir.r4.model.BaseNarrative

class BaseNarrative extends Type implements Serializable

Class org.hl7.fhir.r4.model.BaseReference

class BaseReference extends Type implements Serializable

Class org.hl7.fhir.r4.model.BaseResource

class BaseResource extends Base implements Serializable

serialVersionUID:

1L

Class org.hl7.fhir.r4.model.Basic

class Basic extends DomainResource implements Serializable

serialVersionUID:

650756402L

Serialized Fields

author

Reference author

Indicates who was responsible for creating the resource instance.

authorTarget

Resource authorTarget

The actual object that is the target of the reference (Indicates who was responsible for creating the resource instance.)

code

CodeableConcept code

Identifies the 'type' of resource - equivalent to the resource name for other resources.

created

DateType created

Identifies when the resource was first created.

identifier

List<Identifier> identifier

Identifier assigned to the resource for business purposes, outside the context of FHIR.

subject

Reference subject

Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.)

Class org.hl7.fhir.r4.model.Binary

class Binary extends BaseBinary implements Serializable

serialVersionUID:

1353224198L

Serialized Fields

contentType

CodeType contentType

MimeType of the binary content represented as a standard MimeType (BCP 13).

data

Base64BinaryType data

The actual content, base64 encoded.

securityContext

Reference securityContext

This element identifies another resource that can be used as a proxy of the security sensitivity to use when deciding and enforcing access control rules for the Binary resource. Given that the Binary resource contains very few elements that can be used to determine the sensitivity of the data and relationships to individuals, the referenced resource stands in as a proxy equivalent for this purpose. This referenced resource may be related to the Binary (e.g. Media, DocumentReference), or may be some non-related Resource purely as a security proxy. E.g. to identify that the binary resource relates to a patient, and access should only be granted to applications that have access to the patient.

securityContextTarget

Resource securityContextTarget

The actual object that is the target of the reference (This element identifies another resource that can be used as a proxy of the security sensitivity to use when deciding and enforcing access control rules for the Binary resource. Given that the Binary resource contains very few elements that can be used to determine the sensitivity of the data and relationships to individuals, the referenced resource stands in as a proxy equivalent for this purpose. This referenced resource may be related to the Binary (e.g. Media, DocumentReference), or may be some non-related Resource purely as a security proxy. E.g. to identify that the binary resource relates to a patient, and access should only be granted to applications that have access to the patient.)

Class org.hl7.fhir.r4.model.BiologicallyDerivedProduct

class BiologicallyDerivedProduct extends DomainResource implements Serializable

serialVersionUID:

-1367034547L

Serialized Fields

collection

BiologicallyDerivedProduct.BiologicallyDerivedProductCollectionComponent collection

How this product was collected.

identifier

List<Identifier> identifier

This records identifiers associated with this biologically derived product instance that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

manipulation

BiologicallyDerivedProduct.BiologicallyDerivedProductManipulationComponent manipulation

Any manipulation of product post-collection that is intended to alter the product. For example a buffy-coat enrichment or CD8 reduction of Peripheral Blood Stem Cells to make it more suitable for infusion.

parent

List<Reference> parent

Parent product (if any).

parentTarget

List<BiologicallyDerivedProduct> parentTarget

The actual objects that are the target of the reference (Parent product (if any).)

processing

List<BiologicallyDerivedProduct.BiologicallyDerivedProductProcessingComponent> processing

Any processing of the product during collection that does not change the fundamental nature of the product. For example adding anti-coagulants during the collection of Peripheral Blood Stem Cells.

productCategory

Enumeration<BiologicallyDerivedProduct.BiologicallyDerivedProductCategory> productCategory

Broad category of this product.

productCode

CodeableConcept productCode

A code that identifies the kind of this biologically derived product (SNOMED Ctcode).

quantity

IntegerType quantity

Number of discrete units within this product.

request

List<Reference> request

Procedure request to obtain this biologically derived product.

requestTarget

List<ServiceRequest> requestTarget

The actual objects that are the target of the reference (Procedure request to obtain this biologically derived product.)

status

Enumeration<BiologicallyDerivedProduct.BiologicallyDerivedProductStatus> status

Whether the product is currently available.

storage

List<BiologicallyDerivedProduct.BiologicallyDerivedProductStorageComponent> storage

Product storage.

Class org.hl7.fhir.r4.model.BiologicallyDerivedProduct.BiologicallyDerivedProductCategoryEnumFactory

class BiologicallyDerivedProductCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.BiologicallyDerivedProduct.BiologicallyDerivedProductCollectionComponent

class BiologicallyDerivedProductCollectionComponent extends BackboneElement implements Serializable

serialVersionUID:

892130089L

Serialized Fields

collected

Type collected

Time of product collection.

collector

Reference collector

Healthcare professional who is performing the collection.

collectorTarget

Resource collectorTarget

The actual object that is the target of the reference (Healthcare professional who is performing the collection.)

source

Reference source

The patient or entity, such as a hospital or vendor in the case of a processed/manipulated/manufactured product, providing the product.

sourceTarget

Resource sourceTarget

The actual object that is the target of the reference (The patient or entity, such as a hospital or vendor in the case of a processed/manipulated/manufactured product, providing the product.)

Class org.hl7.fhir.r4.model.BiologicallyDerivedProduct.BiologicallyDerivedProductManipulationComponent

class BiologicallyDerivedProductManipulationComponent extends BackboneElement implements Serializable

serialVersionUID:

717201078L

Serialized Fields

description

StringType description

Description of manipulation.

time

Type time

Time of manipulation.

Class org.hl7.fhir.r4.model.BiologicallyDerivedProduct.BiologicallyDerivedProductProcessingComponent

class BiologicallyDerivedProductProcessingComponent extends BackboneElement implements Serializable

serialVersionUID:

-1007041216L

Serialized Fields

additive

Reference additive

Substance added during processing.

additiveTarget

Substance additiveTarget

The actual object that is the target of the reference (Substance added during processing.)

description

StringType description

Description of of processing.

procedure

CodeableConcept procedure

Procesing code.

time

Type time

Time of processing.

Class org.hl7.fhir.r4.model.BiologicallyDerivedProduct.BiologicallyDerivedProductStatusEnumFactory

class BiologicallyDerivedProductStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.BiologicallyDerivedProduct.BiologicallyDerivedProductStorageComponent

class BiologicallyDerivedProductStorageComponent extends BackboneElement implements Serializable

serialVersionUID:

1509141319L

Serialized Fields

description

StringType description

Description of storage.

duration

Period duration

Storage timeperiod.

scale

Enumeration<BiologicallyDerivedProduct.BiologicallyDerivedProductStorageScale> scale

Temperature scale used.

temperature

DecimalType temperature

Storage temperature.

Class org.hl7.fhir.r4.model.BiologicallyDerivedProduct.BiologicallyDerivedProductStorageScaleEnumFactory

class BiologicallyDerivedProductStorageScaleEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.BodyStructure

class BodyStructure extends DomainResource implements Serializable

serialVersionUID:

1437500387L

Serialized Fields

active

BooleanType active

Whether this body site is in active use.

description

StringType description

A summary, characterization or explanation of the body structure.

identifier

List<Identifier> identifier

Identifier for this instance of the anatomical structure.

image

List<Attachment> image

Image or images used to identify a location.

location

CodeableConcept location

The anatomical location or region of the specimen, lesion, or body structure.

locationQualifier

List<CodeableConcept> locationQualifier

Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.

morphology

CodeableConcept morphology

The kind of structure being represented by the body structure at `BodyStructure.location`. This can define both normal and abnormal morphologies.

patient

Reference patient

The person to which the body site belongs.

patientTarget

Patient patientTarget

The actual object that is the target of the reference (The person to which the body site belongs.)

Class org.hl7.fhir.r4.model.BooleanType

class BooleanType extends PrimitiveType<Boolean> implements Externalizable

serialVersionUID:

3L

Serialization Methods

readExternal

public void readExternal(ObjectInput theIn)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput theOut)
                   throws IOException

Throws:

IOException

Class org.hl7.fhir.r4.model.Bundle

class Bundle extends Resource implements Serializable

serialVersionUID:

1740470158L

Serialized Fields

entry

List<Bundle.BundleEntryComponent> entry

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

identifier

Identifier identifier

A persistent identifier for the bundle that won't change as a bundle is copied from server to server.

link

List<Bundle.BundleLinkComponent> link

A series of links that provide context to this bundle.

signature

Signature signature

Digital Signature - base64 encoded. XML-DSig or a JWT.

timestamp

InstantType timestamp

The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.

total

UnsignedIntType total

If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.

type

Enumeration<Bundle.BundleType> type

Indicates the purpose of this bundle - how it is intended to be used.

Class org.hl7.fhir.r4.model.Bundle.BundleEntryComponent

class BundleEntryComponent extends BackboneElement implements Serializable

serialVersionUID:

517783054L

Serialized Fields

fullUrl

UriType fullUrl

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle) Results from operations might involve resources that are not identified.

link

List<Bundle.BundleLinkComponent> link

A series of links that provide context to this entry.

request

Bundle.BundleEntryRequestComponent request

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

resource

Resource resource

The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

response

Bundle.BundleEntryResponseComponent response

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

search

Bundle.BundleEntrySearchComponent search

Information about the search process that lead to the creation of this entry.

Class org.hl7.fhir.r4.model.Bundle.BundleEntryRequestComponent

class BundleEntryRequestComponent extends BackboneElement implements Serializable

serialVersionUID:

-1349769744L

Serialized Fields

ifMatch

StringType ifMatch

Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).

ifModifiedSince

InstantType ifModifiedSince

Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).

ifNoneExist

StringType ifNoneExist

Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").

ifNoneMatch

StringType ifNoneMatch

If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).

method

Enumeration<Bundle.HTTPVerb> method

In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.

url

UriType url

The URL for this entry, relative to the root (the address to which the request is posted).

Class org.hl7.fhir.r4.model.Bundle.BundleEntryResponseComponent

class BundleEntryResponseComponent extends BackboneElement implements Serializable

serialVersionUID:

923278008L

Serialized Fields

etag

StringType etag

The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).

lastModified

InstantType lastModified

The date/time that the resource was modified on the server.

location

UriType location

The location header created by processing this operation, populated if the operation returns a location.

outcome

Resource outcome

An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.

status

StringType status

The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.

Class org.hl7.fhir.r4.model.Bundle.BundleEntrySearchComponent

class BundleEntrySearchComponent extends BackboneElement implements Serializable

serialVersionUID:

837739866L

Serialized Fields

mode

Enumeration<Bundle.SearchEntryMode> mode

Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

score

DecimalType score

When searching, the server's search ranking score for the entry.

Class org.hl7.fhir.r4.model.Bundle.BundleLinkComponent

class BundleLinkComponent extends BackboneElement implements Serializable

serialVersionUID:

-1010386066L

Serialized Fields

relation

StringType relation

A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1).

url

UriType url

The reference details for the link.

Class org.hl7.fhir.r4.model.Bundle.BundleTypeEnumFactory

class BundleTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Bundle.HTTPVerbEnumFactory

class HTTPVerbEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Bundle.SearchEntryModeEnumFactory

class SearchEntryModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CanonicalType

class CanonicalType extends UriType implements Externalizable

serialVersionUID:

4L

Serialization Methods

readExternal

public void readExternal(ObjectInput theIn)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput theOut)
                   throws IOException

Throws:

IOException

Class org.hl7.fhir.r4.model.CapabilityStatement

class CapabilityStatement extends MetadataResource implements Serializable

serialVersionUID:

-1050288843L

Serialized Fields

copyright

MarkdownType copyright

A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.

document

List<CapabilityStatement.CapabilityStatementDocumentComponent> document

A document definition.

fhirVersion

Enumeration<Enumerations.FHIRVersion> fhirVersion

The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value.

format

List<CodeType> format

A list of the formats supported by this implementation using their content types.

implementation

CapabilityStatement.CapabilityStatementImplementationComponent implementation

Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.

implementationGuide

List<CanonicalType> implementationGuide

A list of implementation guides that the server does (or should) support in their entirety.

imports

List<CanonicalType> imports

Reference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them.

instantiates

List<CanonicalType> instantiates

Reference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details.

kind

Enumeration<CapabilityStatement.CapabilityStatementKind> kind

The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).

messaging

List<CapabilityStatement.CapabilityStatementMessagingComponent> messaging

A description of the messaging capabilities of the solution.

patchFormat

List<CodeType> patchFormat

A list of the patch formats supported by this implementation using their content types.

purpose

MarkdownType purpose

Explanation of why this capability statement is needed and why it has been designed as it has.

rest

List<CapabilityStatement.CapabilityStatementRestComponent> rest

A definition of the restful capabilities of the solution, if any.

software

CapabilityStatement.CapabilityStatementSoftwareComponent software

Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.

Class org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementDocumentComponent

class CapabilityStatementDocumentComponent extends BackboneElement implements Serializable

serialVersionUID:

18026632L

Serialized Fields

documentation

MarkdownType documentation

A description of how the application supports or uses the specified document profile. For example, when documents are created, what action is taken with consumed documents, etc.

mode

Enumeration<CapabilityStatement.DocumentMode> mode

Mode of this document declaration - whether an application is a producer or consumer.

profile

CanonicalType profile

A profile on the document Bundle that constrains which resources are present, and their contents.

Class org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementImplementationComponent

class CapabilityStatementImplementationComponent extends BackboneElement implements Serializable

serialVersionUID:

-1705695694L

Serialized Fields

custodian

Reference custodian

The organization responsible for the management of the instance and oversight of the data on the server at the specified URL.

custodianTarget

Organization custodianTarget

The actual object that is the target of the reference (The organization responsible for the management of the instance and oversight of the data on the server at the specified URL.)

description

StringType description

Information about the specific installation that this capability statement relates to.

url

UrlType url

An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.

Class org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementKindEnumFactory

class CapabilityStatementKindEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementMessagingComponent

class CapabilityStatementMessagingComponent extends BackboneElement implements Serializable

serialVersionUID:

300411231L

Serialized Fields

documentation

MarkdownType documentation

Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, the process for becoming an authorized messaging exchange partner.

endpoint

List<CapabilityStatement.CapabilityStatementMessagingEndpointComponent> endpoint

An endpoint (network accessible address) to which messages and/or replies are to be sent.

reliableCache

UnsignedIntType reliableCache

Length if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender).

supportedMessage

List<CapabilityStatement.CapabilityStatementMessagingSupportedMessageComponent> supportedMessage

References to message definitions for messages this system can send or receive.

Class org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementMessagingEndpointComponent

class CapabilityStatementMessagingEndpointComponent extends BackboneElement implements Serializable

serialVersionUID:

-236946103L

Serialized Fields

address

UrlType address

The network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier.

protocol

Coding protocol

A list of the messaging transport protocol(s) identifiers, supported by this endpoint.

Class org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementMessagingSupportedMessageComponent

class CapabilityStatementMessagingSupportedMessageComponent extends BackboneElement implements Serializable

serialVersionUID:

-1172840676L

Serialized Fields

definition

CanonicalType definition

Points to a message definition that identifies the messaging event, message structure, allowed responses, etc.

mode

Enumeration<CapabilityStatement.EventCapabilityMode> mode

The mode of this event declaration - whether application is sender or receiver.

Class org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementRestComponent

class CapabilityStatementRestComponent extends BackboneElement implements Serializable

serialVersionUID:

-1442029817L

Serialized Fields

compartment

List<CanonicalType> compartment

An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .

documentation

MarkdownType documentation

Information about the system's restful capabilities that apply across all applications, such as security.

interaction

List<CapabilityStatement.SystemInteractionComponent> interaction

A specification of restful operations supported by the system.

mode

Enumeration<CapabilityStatement.RestfulCapabilityMode> mode

Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.

operation

List<CapabilityStatement.CapabilityStatementRestResourceOperationComponent> operation

Definition of an operation or a named query together with its parameters and their meaning and type.

resource

List<CapabilityStatement.CapabilityStatementRestResourceComponent> resource

A specification of the restful capabilities of the solution for a specific resource type.

searchParam

List<CapabilityStatement.CapabilityStatementRestResourceSearchParamComponent> searchParam

Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.

security

CapabilityStatement.CapabilityStatementRestSecurityComponent security

Information about security implementation from an interface perspective - what a client needs to know.

Class org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementRestResourceComponent

class CapabilityStatementRestResourceComponent extends BackboneElement implements Serializable

serialVersionUID:

-1843372337L

Serialized Fields

conditionalCreate

BooleanType conditionalCreate

A flag that indicates that the server supports conditional create.

conditionalDelete

Enumeration<CapabilityStatement.ConditionalDeleteStatus> conditionalDelete

A code that indicates how the server supports conditional delete.

conditionalRead

Enumeration<CapabilityStatement.ConditionalReadStatus> conditionalRead

A code that indicates how the server supports conditional read.

conditionalUpdate

BooleanType conditionalUpdate

A flag that indicates that the server supports conditional update.

documentation

MarkdownType documentation

Additional information about the resource type used by the system.

interaction

List<CapabilityStatement.ResourceInteractionComponent> interaction

Identifies a restful operation supported by the solution.

operation

List<CapabilityStatement.CapabilityStatementRestResourceOperationComponent> operation

Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters.

profile

CanonicalType profile

A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles](profiling.html#profile-uses).

readHistory

BooleanType readHistory

A flag for whether the server is able to return past versions as part of the vRead operation.

referencePolicy

List<Enumeration<CapabilityStatement.ReferenceHandlingPolicy>> referencePolicy

A set of flags that defines how references are supported.

searchInclude

List<StringType> searchInclude

A list of _include values supported by the server.

searchParam

List<CapabilityStatement.CapabilityStatementRestResourceSearchParamComponent> searchParam

Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.

searchRevInclude

List<StringType> searchRevInclude

A list of _revinclude (reverse include) values supported by the server.

supportedProfile

List<CanonicalType> supportedProfile

A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses).

type

CodeType type

A type of resource exposed via the restful interface.

updateCreate

BooleanType updateCreate

A flag to indicate that the server allows or needs to allow the client to create new identities on the server (that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server.

versioning

Enumeration<CapabilityStatement.ResourceVersionPolicy> versioning

This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API.

Class org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementRestResourceOperationComponent

class CapabilityStatementRestResourceOperationComponent extends BackboneElement implements Serializable

serialVersionUID:

-388608084L

Serialized Fields

definition

CanonicalType definition

Where the formal definition can be found. If a server references the base definition of an Operation (i.e. from the specification itself such as ```http://hl7.org/fhir/OperationDefinition/ValueSet-expand```), that means it supports the full capabilities of the operation - e.g. both GET and POST invocation. If it only supports a subset, it must define its own custom [[[OperationDefinition]]] with a 'base' of the original OperationDefinition. The custom definition would describe the specific subset of functionality supported.

documentation

MarkdownType documentation

Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation.

name

StringType name

The name of the operation or query. For an operation, this is the name prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called.

Class org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementRestResourceSearchParamComponent

class CapabilityStatementRestResourceSearchParamComponent extends BackboneElement implements Serializable

serialVersionUID:

-171123928L

Serialized Fields

definition

CanonicalType definition

An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]]). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.

documentation

MarkdownType documentation

This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.

name

StringType name

The name of the search parameter used in the interface.

type

Enumeration<Enumerations.SearchParamType> type

The type of value a search parameter refers to, and how the content is interpreted.

Class org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementRestSecurityComponent

class CapabilityStatementRestSecurityComponent extends BackboneElement implements Serializable

serialVersionUID:

-1348900500L

Serialized Fields

cors

BooleanType cors

Server adds CORS headers when responding to requests - this enables Javascript applications to use the server.

description

MarkdownType description

General description of how security works.

service

List<CodeableConcept> service

Types of security services that are supported/required by the system.

Class org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementSoftwareComponent

class CapabilityStatementSoftwareComponent extends BackboneElement implements Serializable

serialVersionUID:

1819769027L

Serialized Fields

name

StringType name

Name the software is known by.

releaseDate

DateTimeType releaseDate

Date this version of the software was released.

version

StringType version

The version identifier for the software covered by this statement.

Class org.hl7.fhir.r4.model.CapabilityStatement.ConditionalDeleteStatusEnumFactory

class ConditionalDeleteStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CapabilityStatement.ConditionalReadStatusEnumFactory

class ConditionalReadStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CapabilityStatement.DocumentModeEnumFactory

class DocumentModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CapabilityStatement.EventCapabilityModeEnumFactory

class EventCapabilityModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CapabilityStatement.ReferenceHandlingPolicyEnumFactory

class ReferenceHandlingPolicyEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CapabilityStatement.ResourceInteractionComponent

class ResourceInteractionComponent extends BackboneElement implements Serializable

serialVersionUID:

2128937796L

Serialized Fields

code

Enumeration<CapabilityStatement.TypeRestfulInteraction> code

Coded identifier of the operation, supported by the system resource.

documentation

MarkdownType documentation

Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'.

Class org.hl7.fhir.r4.model.CapabilityStatement.ResourceVersionPolicyEnumFactory

class ResourceVersionPolicyEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CapabilityStatement.RestfulCapabilityModeEnumFactory

class RestfulCapabilityModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CapabilityStatement.SystemInteractionComponent

class SystemInteractionComponent extends BackboneElement implements Serializable

serialVersionUID:

-1495143879L

Serialized Fields

code

Enumeration<CapabilityStatement.SystemRestfulInteraction> code

A coded identifier of the operation, supported by the system.

documentation

MarkdownType documentation

Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented.

Class org.hl7.fhir.r4.model.CapabilityStatement.SystemRestfulInteractionEnumFactory

class SystemRestfulInteractionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CapabilityStatement.TypeRestfulInteractionEnumFactory

class TypeRestfulInteractionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CarePlan

class CarePlan extends DomainResource implements Serializable

serialVersionUID:

-584930613L

Serialized Fields

activity

List<CarePlan.CarePlanActivityComponent> activity

Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.

addresses

List<Reference> addresses

Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.

addressesTarget

List<Condition> addressesTarget

The actual objects that are the target of the reference (Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.)

author

Reference author

When populated, the author is responsible for the care plan. The care plan is attributed to the author.

authorTarget

Resource authorTarget

The actual object that is the target of the reference (When populated, the author is responsible for the care plan. The care plan is attributed to the author.)

basedOn

List<Reference> basedOn

A care plan that is fulfilled in whole or in part by this care plan.

basedOnTarget

List<CarePlan> basedOnTarget

The actual objects that are the target of the reference (A care plan that is fulfilled in whole or in part by this care plan.)

careTeam

List<Reference> careTeam

Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.

careTeamTarget

List<CareTeam> careTeamTarget

The actual objects that are the target of the reference (Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.)

category

List<CodeableConcept> category

Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.

contributor

List<Reference> contributor

Identifies the individual(s) or organization who provided the contents of the care plan.

contributorTarget

List<Resource> contributorTarget

The actual objects that are the target of the reference (Identifies the individual(s) or organization who provided the contents of the care plan.)

created

DateTimeType created

Represents when this particular CarePlan record was created in the system, which is often a system-generated date.

description

StringType description

A description of the scope and nature of the plan.

encounter

Reference encounter

The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.)

goal

List<Reference> goal

Describes the intended objective(s) of carrying out the care plan.

goalTarget

List<Goal> goalTarget

The actual objects that are the target of the reference (Describes the intended objective(s) of carrying out the care plan.)

identifier

List<Identifier> identifier

Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

instantiatesCanonical

List<CanonicalType> instantiatesCanonical

The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.

instantiatesUri

List<UriType> instantiatesUri

The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.

intent

Enumeration<CarePlan.CarePlanIntent> intent

Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.

note

List<Annotation> note

General notes about the care plan not covered elsewhere.

partOf

List<Reference> partOf

A larger care plan of which this particular care plan is a component or step.

partOfTarget

List<CarePlan> partOfTarget

The actual objects that are the target of the reference (A larger care plan of which this particular care plan is a component or step.)

period

Period period

Indicates when the plan did (or is intended to) come into effect and end.

replaces

List<Reference> replaces

Completed or terminated care plan whose function is taken by this new care plan.

replacesTarget

List<CarePlan> replacesTarget

The actual objects that are the target of the reference (Completed or terminated care plan whose function is taken by this new care plan.)

status

Enumeration<CarePlan.CarePlanStatus> status

Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

subject

Reference subject

Identifies the patient or group whose intended care is described by the plan.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (Identifies the patient or group whose intended care is described by the plan.)

supportingInfo

List<Reference> supportingInfo

Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.

supportingInfoTarget

List<Resource> supportingInfoTarget

The actual objects that are the target of the reference (Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.)

title

StringType title

Human-friendly name for the care plan.

Class org.hl7.fhir.r4.model.CarePlan.CarePlanActivityComponent

class CarePlanActivityComponent extends BackboneElement implements Serializable

serialVersionUID:

-609287300L

Serialized Fields

detail

CarePlan.CarePlanActivityDetailComponent detail

A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.

outcomeCodeableConcept

List<CodeableConcept> outcomeCodeableConcept

Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).

outcomeReference

List<Reference> outcomeReference

Details of the outcome or action resulting from the activity. The reference to an "event" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a ?request? resource).

outcomeReferenceTarget

List<Resource> outcomeReferenceTarget

The actual objects that are the target of the reference (Details of the outcome or action resulting from the activity. The reference to an "event" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a ?request? resource).)

progress

List<Annotation> progress

Notes about the adherence/status/progress of the activity.

reference

Reference reference

The details of the proposed activity represented in a specific resource.

referenceTarget

Resource referenceTarget

The actual object that is the target of the reference (The details of the proposed activity represented in a specific resource.)

Class org.hl7.fhir.r4.model.CarePlan.CarePlanActivityDetailComponent

class CarePlanActivityDetailComponent extends BackboneElement implements Serializable

serialVersionUID:

1355568081L

Serialized Fields

code

CodeableConcept code

Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter.

dailyAmount

Quantity dailyAmount

Identifies the quantity expected to be consumed in a given day.

description

StringType description

This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.

doNotPerform

BooleanType doNotPerform

If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan.

goal

List<Reference> goal

Internal reference that identifies the goals that this activity is intended to contribute towards meeting.

goalTarget

List<Goal> goalTarget

The actual objects that are the target of the reference (Internal reference that identifies the goals that this activity is intended to contribute towards meeting.)

instantiatesCanonical

List<CanonicalType> instantiatesCanonical

The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.

instantiatesUri

List<UriType> instantiatesUri

The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.

kind

Enumeration<CarePlan.CarePlanActivityKind> kind

A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.

location

Reference location

Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.

locationTarget

Location locationTarget

The actual object that is the target of the reference (Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)

performer

List<Reference> performer

Identifies who's expected to be involved in the activity.

performerTarget

List<Resource> performerTarget

The actual objects that are the target of the reference (Identifies who's expected to be involved in the activity.)

product

Type product

Identifies the food, drug or other product to be consumed or supplied in the activity.

quantity

Quantity quantity

Identifies the quantity expected to be supplied, administered or consumed by the subject.

reasonCode

List<CodeableConcept> reasonCode

Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.

reasonReference

List<Reference> reasonReference

Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan.

reasonReferenceTarget

List<Resource> reasonReferenceTarget

The actual objects that are the target of the reference (Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan.)

scheduled

Type scheduled

The period, timing or frequency upon which the described activity is to occur.

status

Enumeration<CarePlan.CarePlanActivityStatus> status

Identifies what progress is being made for the specific activity.

statusReason

CodeableConcept statusReason

Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.

Class org.hl7.fhir.r4.model.CarePlan.CarePlanActivityKindEnumFactory

class CarePlanActivityKindEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CarePlan.CarePlanActivityStatusEnumFactory

class CarePlanActivityStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CarePlan.CarePlanIntentEnumFactory

class CarePlanIntentEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CarePlan.CarePlanStatusEnumFactory

class CarePlanStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CareTeam

class CareTeam extends DomainResource implements Serializable

serialVersionUID:

1793069286L

Serialized Fields

category

List<CodeableConcept> category

Identifies what kind of team. This is to support differentiation between multiple co-existing teams, such as care plan team, episode of care team, longitudinal care team.

encounter

Reference encounter

The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.)

identifier

List<Identifier> identifier

Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

managingOrganization

List<Reference> managingOrganization

The organization responsible for the care team.

managingOrganizationTarget

List<Organization> managingOrganizationTarget

The actual objects that are the target of the reference (The organization responsible for the care team.)

name

StringType name

A label for human use intended to distinguish like teams. E.g. the "red" vs. "green" trauma teams.

note

List<Annotation> note

Comments made about the CareTeam.

participant

List<CareTeam.CareTeamParticipantComponent> participant

Identifies all people and organizations who are expected to be involved in the care team.

period

Period period

Indicates when the team did (or is intended to) come into effect and end.

reasonCode

List<CodeableConcept> reasonCode

Describes why the care team exists.

reasonReference

List<Reference> reasonReference

Condition(s) that this care team addresses.

reasonReferenceTarget

List<Condition> reasonReferenceTarget

The actual objects that are the target of the reference (Condition(s) that this care team addresses.)

status

Enumeration<CareTeam.CareTeamStatus> status

Indicates the current state of the care team.

subject

Reference subject

Identifies the patient or group whose intended care is handled by the team.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (Identifies the patient or group whose intended care is handled by the team.)

telecom

List<ContactPoint> telecom

A central contact detail for the care team (that applies to all members).

Class org.hl7.fhir.r4.model.CareTeam.CareTeamParticipantComponent

class CareTeamParticipantComponent extends BackboneElement implements Serializable

serialVersionUID:

-575634410L

Serialized Fields

member

Reference member

The specific person or organization who is participating/expected to participate in the care team.

memberTarget

Resource memberTarget

The actual object that is the target of the reference (The specific person or organization who is participating/expected to participate in the care team.)

onBehalfOf

Reference onBehalfOf

The organization of the practitioner.

onBehalfOfTarget

Organization onBehalfOfTarget

The actual object that is the target of the reference (The organization of the practitioner.)

period

Period period

Indicates when the specific member or organization did (or is intended to) come into effect and end.

role

List<CodeableConcept> role

Indicates specific responsibility of an individual within the care team, such as "Primary care physician", "Trained social worker counselor", "Caregiver", etc.

Class org.hl7.fhir.r4.model.CareTeam.CareTeamStatusEnumFactory

class CareTeamStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CatalogEntry

class CatalogEntry extends DomainResource implements Serializable

serialVersionUID:

57448275L

Serialized Fields

additionalCharacteristic

List<CodeableConcept> additionalCharacteristic

Used for examplefor Out of Formulary, or any specifics.

additionalClassification

List<CodeableConcept> additionalClassification

User for example for ATC classification, or.

additionalIdentifier

List<Identifier> additionalIdentifier

Used in supporting related concepts, e.g. NDC to RxNorm.

classification

List<CodeableConcept> classification

Classes of devices, or ATC for medication.

identifier

List<Identifier> identifier

Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.

lastUpdated

DateTimeType lastUpdated

Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.

orderable

BooleanType orderable

Whether the entry represents an orderable item.

referencedItem

Reference referencedItem

The item in a catalog or definition.

referencedItemTarget

Resource referencedItemTarget

The actual object that is the target of the reference (The item in a catalog or definition.)

relatedEntry

List<CatalogEntry.CatalogEntryRelatedEntryComponent> relatedEntry

Used for example, to point to a substance, or to a device used to administer a medication.

status

Enumeration<Enumerations.PublicationStatus> status

Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.

type

CodeableConcept type

The type of item - medication, device, service, protocol or other.

validityPeriod

Period validityPeriod

The time period in which this catalog entry is expected to be active.

validTo

DateTimeType validTo

The date until which this catalog entry is expected to be active.

Class org.hl7.fhir.r4.model.CatalogEntry.CatalogEntryRelatedEntryComponent

class CatalogEntryRelatedEntryComponent extends BackboneElement implements Serializable

serialVersionUID:

-1367020813L

Serialized Fields

item

Reference item

The reference to the related item.

itemTarget

CatalogEntry itemTarget

The actual object that is the target of the reference (The reference to the related item.)

relationtype

Enumeration<CatalogEntry.CatalogEntryRelationType> relationtype

The type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc.

Class org.hl7.fhir.r4.model.CatalogEntry.CatalogEntryRelationTypeEnumFactory

class CatalogEntryRelationTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ChargeItem

class ChargeItem extends DomainResource implements Serializable

serialVersionUID:

1748644267L

Serialized Fields

account

List<Reference> account

Account into which this ChargeItems belongs.

accountTarget

List<Account> accountTarget

The actual objects that are the target of the reference (Account into which this ChargeItems belongs.)

bodysite

List<CodeableConcept> bodysite

The anatomical location where the related service has been applied.

code

CodeableConcept code

A code that identifies the charge, like a billing code.

context

Reference context

The encounter or episode of care that establishes the context for this event.

contextTarget

Resource contextTarget

The actual object that is the target of the reference (The encounter or episode of care that establishes the context for this event.)

costCenter

Reference costCenter

The financial cost center permits the tracking of charge attribution.

costCenterTarget

Organization costCenterTarget

The actual object that is the target of the reference (The financial cost center permits the tracking of charge attribution.)

definitionCanonical

List<CanonicalType> definitionCanonical

References the source of pricing information, rules of application for the code this ChargeItem uses.

definitionUri

List<UriType> definitionUri

References the (external) source of pricing information, rules of application for the code this ChargeItem uses.

enteredDate

DateTimeType enteredDate

Date the charge item was entered.

enterer

Reference enterer

The device, practitioner, etc. who entered the charge item.

entererTarget

Resource entererTarget

The actual object that is the target of the reference (The device, practitioner, etc. who entered the charge item.)

factorOverride

DecimalType factorOverride

Factor overriding the factor determined by the rules associated with the code.

identifier

List<Identifier> identifier

Identifiers assigned to this event performer or other systems.

note

List<Annotation> note

Comments made about the event by the performer, subject or other participants.

occurrence

Type occurrence

Date/time(s) or duration when the charged service was applied.

overrideReason

StringType overrideReason

If the list price or the rule-based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action.

partOf

List<Reference> partOf

ChargeItems can be grouped to larger ChargeItems covering the whole set.

partOfTarget

List<ChargeItem> partOfTarget

The actual objects that are the target of the reference (ChargeItems can be grouped to larger ChargeItems covering the whole set.)

performer

List<ChargeItem.ChargeItemPerformerComponent> performer

Indicates who or what performed or participated in the charged service.

performingOrganization

Reference performingOrganization

The organization requesting the service.

performingOrganizationTarget

Organization performingOrganizationTarget

The actual object that is the target of the reference (The organization requesting the service.)

priceOverride

Money priceOverride

Total price of the charge overriding the list price associated with the code.

product

Type product

Identifies the device, food, drug or other product being charged either by type code or reference to an instance.

quantity

Quantity quantity

Quantity of which the charge item has been serviced.

reason

List<CodeableConcept> reason

Describes why the event occurred in coded or textual form.

requestingOrganization

Reference requestingOrganization

The organization performing the service.

requestingOrganizationTarget

Organization requestingOrganizationTarget

The actual object that is the target of the reference (The organization performing the service.)

service

List<Reference> service

Indicated the rendered service that caused this charge.

serviceTarget

List<Resource> serviceTarget

The actual objects that are the target of the reference (Indicated the rendered service that caused this charge.)

status

Enumeration<ChargeItem.ChargeItemStatus> status

The current state of the ChargeItem.

subject

Reference subject

The individual or set of individuals the action is being or was performed on.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (The individual or set of individuals the action is being or was performed on.)

supportingInformation

List<Reference> supportingInformation

Further information supporting this charge.

supportingInformationTarget

List<Resource> supportingInformationTarget

The actual objects that are the target of the reference (Further information supporting this charge.)

Class org.hl7.fhir.r4.model.ChargeItem.ChargeItemPerformerComponent

class ChargeItemPerformerComponent extends BackboneElement implements Serializable

serialVersionUID:

1424001049L

Serialized Fields

actor

Reference actor

The device, practitioner, etc. who performed or participated in the service.

actorTarget

Resource actorTarget

The actual object that is the target of the reference (The device, practitioner, etc. who performed or participated in the service.)

function

CodeableConcept function

Describes the type of performance or participation(e.g. primary surgeon, anesthesiologiest, etc.).

Class org.hl7.fhir.r4.model.ChargeItem.ChargeItemStatusEnumFactory

class ChargeItemStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ChargeItemDefinition

class ChargeItemDefinition extends MetadataResource implements Serializable

serialVersionUID:

-583681330L

Serialized Fields

applicability

List<ChargeItemDefinition.ChargeItemDefinitionApplicabilityComponent> applicability

Expressions that describe applicability criteria for the billing code.

approvalDate

DateType approvalDate

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

code

CodeableConcept code

The defined billing details in this resource pertain to the given billing code.

copyright

MarkdownType copyright

A copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition.

derivedFromUri

List<UriType> derivedFromUri

The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.

effectivePeriod

Period effectivePeriod

The period during which the charge item definition content was or is planned to be in active use.

identifier

List<Identifier> identifier

A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

instance

List<Reference> instance

The defined billing details in this resource pertain to the given product instance(s).

instanceTarget

List<Resource> instanceTarget

The actual objects that are the target of the reference (The defined billing details in this resource pertain to the given product instance(s).)

lastReviewDate

DateType lastReviewDate

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

partOf

List<CanonicalType> partOf

A larger definition of which this particular definition is a component or step.

propertyGroup

List<ChargeItemDefinition.ChargeItemDefinitionPropertyGroupComponent> propertyGroup

Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.

replaces

List<CanonicalType> replaces

As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.

Class org.hl7.fhir.r4.model.ChargeItemDefinition.ChargeItemDefinitionApplicabilityComponent

class ChargeItemDefinitionApplicabilityComponent extends BackboneElement implements Serializable

serialVersionUID:

1354288281L

Serialized Fields

description

StringType description

A brief, natural language description of the condition that effectively communicates the intended semantics.

expression

StringType expression

An expression that returns true or false, indicating whether the condition is satisfied. When using FHIRPath expressions, the %context environment variable must be replaced at runtime with the ChargeItem resource to which this definition is applied.

language

StringType language

The media type of the language for the expression, e.g. "text/cql" for Clinical Query Language expressions or "text/fhirpath" for FHIRPath expressions.

Class org.hl7.fhir.r4.model.ChargeItemDefinition.ChargeItemDefinitionPriceComponentTypeEnumFactory

class ChargeItemDefinitionPriceComponentTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ChargeItemDefinition.ChargeItemDefinitionPropertyGroupComponent

class ChargeItemDefinitionPropertyGroupComponent extends BackboneElement implements Serializable

serialVersionUID:

1723436176L

Serialized Fields

applicability

List<ChargeItemDefinition.ChargeItemDefinitionApplicabilityComponent> applicability

Expressions that describe applicability criteria for the priceComponent.

priceComponent

List<ChargeItemDefinition.ChargeItemDefinitionPropertyGroupPriceComponentComponent> priceComponent

The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the prices have been calculated.

Class org.hl7.fhir.r4.model.ChargeItemDefinition.ChargeItemDefinitionPropertyGroupPriceComponentComponent

class ChargeItemDefinitionPropertyGroupPriceComponentComponent extends BackboneElement implements Serializable

serialVersionUID:

-841451335L

Serialized Fields

amount

Money amount

The amount calculated for this component.

code

CodeableConcept code

A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.

factor

DecimalType factor

The factor that has been applied on the base price for calculating this component.

type

Enumeration<ChargeItemDefinition.ChargeItemDefinitionPriceComponentType> type

This code identifies the type of the component.

Class org.hl7.fhir.r4.model.Claim

class Claim extends DomainResource implements Serializable

serialVersionUID:

-80376108L

Serialized Fields

accident

Claim.AccidentComponent accident

Details of an accident which resulted in injuries which required the products and services listed in the claim.

billablePeriod

Period billablePeriod

The period for which charges are being submitted.

careTeam

List<Claim.CareTeamComponent> careTeam

The members of the team who provided the products and services.

created

DateTimeType created

The date this resource was created.

diagnosis

List<Claim.DiagnosisComponent> diagnosis

Information about diagnoses relevant to the claim items.

enterer

Reference enterer

Individual who created the claim, predetermination or preauthorization.

entererTarget

Resource entererTarget

The actual object that is the target of the reference (Individual who created the claim, predetermination or preauthorization.)

facility

Reference facility

Facility where the services were provided.

facilityTarget

Location facilityTarget

The actual object that is the target of the reference (Facility where the services were provided.)

fundsReserve

CodeableConcept fundsReserve

A code to indicate whether and for whom funds are to be reserved for future claims.

identifier

List<Identifier> identifier

A unique identifier assigned to this claim.

insurance

List<Claim.InsuranceComponent> insurance

Financial instruments for reimbursement for the health care products and services specified on the claim.

insurer

Reference insurer

The Insurer who is target of the request.

insurerTarget

Organization insurerTarget

The actual object that is the target of the reference (The Insurer who is target of the request.)

item

List<Claim.ItemComponent> item

A claim line. Either a simple product or service or a 'group' of details which can each be a simple items or groups of sub-details.

originalPrescription

Reference originalPrescription

Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.

originalPrescriptionTarget

Resource originalPrescriptionTarget

The actual object that is the target of the reference (Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.)

patient

Reference patient

The party to whom the professional services and/or products have been supplied or are being considered and for whom actual or forecast reimbursement is sought.

patientTarget

Patient patientTarget

The actual object that is the target of the reference (The party to whom the professional services and/or products have been supplied or are being considered and for whom actual or forecast reimbursement is sought.)

payee

Claim.PayeeComponent payee

The party to be reimbursed for cost of the products and services according to the terms of the policy.

prescription

Reference prescription

Prescription to support the dispensing of pharmacy, device or vision products.

prescriptionTarget

Resource prescriptionTarget

The actual object that is the target of the reference (Prescription to support the dispensing of pharmacy, device or vision products.)

priority

CodeableConcept priority

The provider-required urgency of processing the request. Typical values include: stat, routine deferred.

procedure

List<Claim.ProcedureComponent> procedure

Procedures performed on the patient relevant to the billing items with the claim.

provider

Reference provider

The provider which is responsible for the claim, predetermination or preauthorization.

providerTarget

Resource providerTarget

The actual object that is the target of the reference (The provider which is responsible for the claim, predetermination or preauthorization.)

referral

Reference referral

A reference to a referral resource.

referralTarget

ServiceRequest referralTarget

The actual object that is the target of the reference (A reference to a referral resource.)

related

List<Claim.RelatedClaimComponent> related

Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.

status

Enumeration<Claim.ClaimStatus> status

The status of the resource instance.

subType

CodeableConcept subType

A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

supportingInfo

List<Claim.SupportingInformationComponent> supportingInfo

Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.

total

Money total

The total value of the all the items in the claim.

type

CodeableConcept type

The category of claim, e.g. oral, pharmacy, vision, institutional, professional.

use

Enumeration<Claim.Use> use

A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.

Class org.hl7.fhir.r4.model.Claim.AccidentComponent

class AccidentComponent extends BackboneElement implements Serializable

serialVersionUID:

622904984L

Serialized Fields

date

DateType date

Date of an accident event related to the products and services contained in the claim.

location

Type location

The physical location of the accident event.

type

CodeableConcept type

The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers.

Class org.hl7.fhir.r4.model.Claim.CareTeamComponent

class CareTeamComponent extends BackboneElement implements Serializable

serialVersionUID:

1758966968L

Serialized Fields

provider

Reference provider

Member of the team who provided the product or service.

providerTarget

Resource providerTarget

The actual object that is the target of the reference (Member of the team who provided the product or service.)

qualification

CodeableConcept qualification

The qualification of the practitioner which is applicable for this service.

responsible

BooleanType responsible

The party who is billing and/or responsible for the claimed products or services.

role

CodeableConcept role

The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team.

sequence

PositiveIntType sequence

A number to uniquely identify care team entries.

Class org.hl7.fhir.r4.model.Claim.ClaimStatusEnumFactory

class ClaimStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Claim.DetailComponent

class DetailComponent extends BackboneElement implements Serializable

serialVersionUID:

-1245004924L

Serialized Fields

category

CodeableConcept category

Code to identify the general type of benefits under which products and services are provided.

factor

DecimalType factor

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

modifier

List<CodeableConcept> modifier

Item typification or modifiers codes to convey additional context for the product or service.

net

Money net

The quantity times the unit price for an additional service or product or charge.

productOrService

CodeableConcept productOrService

When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

programCode

List<CodeableConcept> programCode

Identifies the program under which this may be recovered.

quantity

Quantity quantity

The number of repetitions of a service or product.

revenue

CodeableConcept revenue

The type of revenue or cost center providing the product and/or service.

sequence

PositiveIntType sequence

A number to uniquely identify item entries.

subDetail

List<Claim.SubDetailComponent> subDetail

A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

udi

List<Reference> udi

Unique Device Identifiers associated with this line item.

udiTarget

List<Device> udiTarget

The actual objects that are the target of the reference (Unique Device Identifiers associated with this line item.)

unitPrice

Money unitPrice

If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

Class org.hl7.fhir.r4.model.Claim.DiagnosisComponent

class DiagnosisComponent extends BackboneElement implements Serializable

serialVersionUID:

2120593974L

Serialized Fields

diagnosis

Type diagnosis

The nature of illness or problem in a coded form or as a reference to an external defined Condition.

onAdmission

CodeableConcept onAdmission

Indication of whether the diagnosis was present on admission to a facility.

packageCode

CodeableConcept packageCode

A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.

sequence

PositiveIntType sequence

A number to uniquely identify diagnosis entries.

type

List<CodeableConcept> type

When the condition was observed or the relative ranking.

Class org.hl7.fhir.r4.model.Claim.InsuranceComponent

class InsuranceComponent extends BackboneElement implements Serializable

serialVersionUID:

-1711744215L

Serialized Fields

businessArrangement

StringType businessArrangement

A business agreement number established between the provider and the insurer for special business processing purposes.

claimResponse

Reference claimResponse

The result of the adjudication of the line items for the Coverage specified in this insurance.

claimResponseTarget

ClaimResponse claimResponseTarget

The actual object that is the target of the reference (The result of the adjudication of the line items for the Coverage specified in this insurance.)

coverage

Reference coverage

Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.

coverageTarget

Coverage coverageTarget

The actual object that is the target of the reference (Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.)

focal

BooleanType focal

A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.

identifier

Identifier identifier

The business identifier to be used when the claim is sent for adjudication against this insurance policy.

preAuthRef

List<StringType> preAuthRef

Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization.

sequence

PositiveIntType sequence

A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.

Class org.hl7.fhir.r4.model.Claim.ItemComponent

class ItemComponent extends BackboneElement implements Serializable

serialVersionUID:

-329028323L

Serialized Fields

bodySite

CodeableConcept bodySite

Physical service site on the patient (limb, tooth, etc.).

careTeamSequence

List<PositiveIntType> careTeamSequence

CareTeam members related to this service or product.

category

CodeableConcept category

Code to identify the general type of benefits under which products and services are provided.

detail

List<Claim.DetailComponent> detail

A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

diagnosisSequence

List<PositiveIntType> diagnosisSequence

Diagnosis applicable for this service or product.

encounter

List<Reference> encounter

The Encounters during which this Claim was created or to which the creation of this record is tightly associated.

encounterTarget

List<Encounter> encounterTarget

The actual objects that are the target of the reference (The Encounters during which this Claim was created or to which the creation of this record is tightly associated.)

factor

DecimalType factor

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

informationSequence

List<PositiveIntType> informationSequence

Exceptions, special conditions and supporting information applicable for this service or product.

location

Type location

Where the product or service was provided.

modifier

List<CodeableConcept> modifier

Item typification or modifiers codes to convey additional context for the product or service.

net

Money net

The quantity times the unit price for an additional service or product or charge.

procedureSequence

List<PositiveIntType> procedureSequence

Procedures applicable for this service or product.

productOrService

CodeableConcept productOrService

When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

programCode

List<CodeableConcept> programCode

Identifies the program under which this may be recovered.

quantity

Quantity quantity

The number of repetitions of a service or product.

revenue

CodeableConcept revenue

The type of revenue or cost center providing the product and/or service.

sequence

PositiveIntType sequence

A number to uniquely identify item entries.

serviced

Type serviced

The date or dates when the service or product was supplied, performed or completed.

subSite

List<CodeableConcept> subSite

A region or surface of the bodySite, e.g. limb region or tooth surface(s).

udi

List<Reference> udi

Unique Device Identifiers associated with this line item.

udiTarget

List<Device> udiTarget

The actual objects that are the target of the reference (Unique Device Identifiers associated with this line item.)

unitPrice

Money unitPrice

If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

Class org.hl7.fhir.r4.model.Claim.PayeeComponent

class PayeeComponent extends BackboneElement implements Serializable

serialVersionUID:

1609484699L

Serialized Fields

party

Reference party

Reference to the individual or organization to whom any payment will be made.

partyTarget

Resource partyTarget

The actual object that is the target of the reference (Reference to the individual or organization to whom any payment will be made.)

type

CodeableConcept type

Type of Party to be reimbursed: subscriber, provider, other.

Class org.hl7.fhir.r4.model.Claim.ProcedureComponent

class ProcedureComponent extends BackboneElement implements Serializable

serialVersionUID:

935341852L

Serialized Fields

date

DateTimeType date

Date and optionally time the procedure was performed.

procedure

Type procedure

The code or reference to a Procedure resource which identifies the clinical intervention performed.

sequence

PositiveIntType sequence

A number to uniquely identify procedure entries.

type

List<CodeableConcept> type

When the condition was observed or the relative ranking.

udi

List<Reference> udi

Unique Device Identifiers associated with this line item.

udiTarget

List<Device> udiTarget

The actual objects that are the target of the reference (Unique Device Identifiers associated with this line item.)

Class org.hl7.fhir.r4.model.Claim.RelatedClaimComponent

class RelatedClaimComponent extends BackboneElement implements Serializable

serialVersionUID:

-379338905L

Serialized Fields

claim

Reference claim

Reference to a related claim.

claimTarget

Claim claimTarget

The actual object that is the target of the reference (Reference to a related claim.)

reference

Identifier reference

An alternate organizational reference to the case or file to which this particular claim pertains.

relationship

CodeableConcept relationship

A code to convey how the claims are related.

Class org.hl7.fhir.r4.model.Claim.SubDetailComponent

class SubDetailComponent extends BackboneElement implements Serializable

serialVersionUID:

1133026301L

Serialized Fields

category

CodeableConcept category

Code to identify the general type of benefits under which products and services are provided.

factor

DecimalType factor

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

modifier

List<CodeableConcept> modifier

Item typification or modifiers codes to convey additional context for the product or service.

net

Money net

The quantity times the unit price for an additional service or product or charge.

productOrService

CodeableConcept productOrService

When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

programCode

List<CodeableConcept> programCode

Identifies the program under which this may be recovered.

quantity

Quantity quantity

The number of repetitions of a service or product.

revenue

CodeableConcept revenue

The type of revenue or cost center providing the product and/or service.

sequence

PositiveIntType sequence

A number to uniquely identify item entries.

udi

List<Reference> udi

Unique Device Identifiers associated with this line item.

udiTarget

List<Device> udiTarget

The actual objects that are the target of the reference (Unique Device Identifiers associated with this line item.)

unitPrice

Money unitPrice

If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

Class org.hl7.fhir.r4.model.Claim.SupportingInformationComponent

class SupportingInformationComponent extends BackboneElement implements Serializable

serialVersionUID:

-518630232L

Serialized Fields

category

CodeableConcept category

The general class of the information supplied: information; exception; accident, employment; onset, etc.

code

CodeableConcept code

System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.

reason

CodeableConcept reason

Provides the reason in the situation where a reason code is required in addition to the content.

sequence

PositiveIntType sequence

A number to uniquely identify supporting information entries.

timing

Type timing

The date when or period to which this information refers.

value

Type value

Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

Class org.hl7.fhir.r4.model.Claim.UseEnumFactory

class UseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ClaimResponse

class ClaimResponse extends DomainResource implements Serializable

serialVersionUID:

731586651L

Serialized Fields

addItem

List<ClaimResponse.AddedItemComponent> addItem

The first-tier service adjudications for payor added product or service lines.

adjudication

List<ClaimResponse.AdjudicationComponent> adjudication

The adjudication results which are presented at the header level rather than at the line-item or add-item levels.

communicationRequest

List<Reference> communicationRequest

Request for additional supporting or authorizing information.

communicationRequestTarget

List<CommunicationRequest> communicationRequestTarget

The actual objects that are the target of the reference (Request for additional supporting or authorizing information.)

created

DateTimeType created

The date this resource was created.

disposition

StringType disposition

A human readable description of the status of the adjudication.

error

List<ClaimResponse.ErrorComponent> error

Errors encountered during the processing of the adjudication.

form

Attachment form

The actual form, by reference or inclusion, for printing the content or an EOB.

formCode

CodeableConcept formCode

A code for the form to be used for printing the content.

fundsReserve

CodeableConcept fundsReserve

A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.

identifier

List<Identifier> identifier

A unique identifier assigned to this claim response.

insurance

List<ClaimResponse.InsuranceComponent> insurance

Financial instruments for reimbursement for the health care products and services specified on the claim.

insurer

Reference insurer

The party responsible for authorization, adjudication and reimbursement.

insurerTarget

Organization insurerTarget

The actual object that is the target of the reference (The party responsible for authorization, adjudication and reimbursement.)

item

List<ClaimResponse.ItemComponent> item

A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.

outcome

Enumeration<ClaimResponse.RemittanceOutcome> outcome

The outcome of the claim, predetermination, or preauthorization processing.

patient

Reference patient

The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought.

patientTarget

Patient patientTarget

The actual object that is the target of the reference (The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought.)

payeeType

CodeableConcept payeeType

Type of Party to be reimbursed: subscriber, provider, other.

payment

ClaimResponse.PaymentComponent payment

Payment details for the adjudication of the claim.

preAuthPeriod

Period preAuthPeriod

The time frame during which this authorization is effective.

preAuthRef

StringType preAuthRef

Reference from the Insurer which is used in later communications which refers to this adjudication.

processNote

List<ClaimResponse.NoteComponent> processNote

A note that describes or explains adjudication results in a human readable form.

request

Reference request

Original request resource reference.

requestor

Reference requestor

The provider which is responsible for the claim, predetermination or preauthorization.

requestorTarget

Resource requestorTarget

The actual object that is the target of the reference (The provider which is responsible for the claim, predetermination or preauthorization.)

requestTarget

Claim requestTarget

The actual object that is the target of the reference (Original request resource reference.)

status

Enumeration<ClaimResponse.ClaimResponseStatus> status

The status of the resource instance.

subType

CodeableConcept subType

A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

total

List<ClaimResponse.TotalComponent> total

Categorized monetary totals for the adjudication.

type

CodeableConcept type

A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

use

Enumeration<ClaimResponse.Use> use

A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.

Class org.hl7.fhir.r4.model.ClaimResponse.AddedItemComponent

class AddedItemComponent extends BackboneElement implements Serializable

serialVersionUID:

-1193747282L

Serialized Fields

adjudication

List<ClaimResponse.AdjudicationComponent> adjudication

The adjudication results.

bodySite

CodeableConcept bodySite

Physical service site on the patient (limb, tooth, etc.).

detail

List<ClaimResponse.AddedItemDetailComponent> detail

The second-tier service adjudications for payor added services.

detailSequence

List<PositiveIntType> detailSequence

The sequence number of the details within the claim item which this line is intended to replace.

factor

DecimalType factor

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

itemSequence

List<PositiveIntType> itemSequence

Claim items which this service line is intended to replace.

location

Type location

Where the product or service was provided.

modifier

List<CodeableConcept> modifier

Item typification or modifiers codes to convey additional context for the product or service.

net

Money net

The quantity times the unit price for an additional service or product or charge.

noteNumber

List<PositiveIntType> noteNumber

The numbers associated with notes below which apply to the adjudication of this item.

productOrService

CodeableConcept productOrService

When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

programCode

List<CodeableConcept> programCode

Identifies the program under which this may be recovered.

provider

List<Reference> provider

The providers who are authorized for the services rendered to the patient.

providerTarget

List<Resource> providerTarget

The actual objects that are the target of the reference (The providers who are authorized for the services rendered to the patient.)

quantity

Quantity quantity

The number of repetitions of a service or product.

serviced

Type serviced

The date or dates when the service or product was supplied, performed or completed.

subdetailSequence

List<PositiveIntType> subdetailSequence

The sequence number of the sub-details within the details within the claim item which this line is intended to replace.

subSite

List<CodeableConcept> subSite

A region or surface of the bodySite, e.g. limb region or tooth surface(s).

unitPrice

Money unitPrice

If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

Class org.hl7.fhir.r4.model.ClaimResponse.AddedItemDetailComponent

class AddedItemDetailComponent extends BackboneElement implements Serializable

serialVersionUID:

-1436724060L

Serialized Fields

adjudication

List<ClaimResponse.AdjudicationComponent> adjudication

The adjudication results.

factor

DecimalType factor

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

modifier

List<CodeableConcept> modifier

Item typification or modifiers codes to convey additional context for the product or service.

net

Money net

The quantity times the unit price for an additional service or product or charge.

noteNumber

List<PositiveIntType> noteNumber

The numbers associated with notes below which apply to the adjudication of this item.

productOrService

CodeableConcept productOrService

When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

quantity

Quantity quantity

The number of repetitions of a service or product.

subDetail

List<ClaimResponse.AddedItemSubDetailComponent> subDetail

The third-tier service adjudications for payor added services.

unitPrice

Money unitPrice

If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

Class org.hl7.fhir.r4.model.ClaimResponse.AddedItemSubDetailComponent

class AddedItemSubDetailComponent extends BackboneElement implements Serializable

serialVersionUID:

1301363592L

Serialized Fields

adjudication

List<ClaimResponse.AdjudicationComponent> adjudication

The adjudication results.

factor

DecimalType factor

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

modifier

List<CodeableConcept> modifier

Item typification or modifiers codes to convey additional context for the product or service.

net

Money net

The quantity times the unit price for an additional service or product or charge.

noteNumber

List<PositiveIntType> noteNumber

The numbers associated with notes below which apply to the adjudication of this item.

productOrService

CodeableConcept productOrService

When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

quantity

Quantity quantity

The number of repetitions of a service or product.

unitPrice

Money unitPrice

If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

Class org.hl7.fhir.r4.model.ClaimResponse.AdjudicationComponent

class AdjudicationComponent extends BackboneElement implements Serializable

serialVersionUID:

1559898786L

Serialized Fields

amount

Money amount

Monetary amount associated with the category.

category

CodeableConcept category

A code to indicate the information type of this adjudication record. Information types may include the value submitted, maximum values or percentages allowed or payable under the plan, amounts that: the patient is responsible for in aggregate or pertaining to this item; amounts paid by other coverages; and, the benefit payable for this item.

reason

CodeableConcept reason

A code supporting the understanding of the adjudication result and explaining variance from expected amount.

value

DecimalType value

A non-monetary value associated with the category. Mutually exclusive to the amount element above.

Class org.hl7.fhir.r4.model.ClaimResponse.ClaimResponseStatusEnumFactory

class ClaimResponseStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ClaimResponse.ErrorComponent

class ErrorComponent extends BackboneElement implements Serializable

serialVersionUID:

843818320L

Serialized Fields

code

CodeableConcept code

An error code, from a specified code system, which details why the claim could not be adjudicated.

detailSequence

PositiveIntType detailSequence

The sequence number of the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.

itemSequence

PositiveIntType itemSequence

The sequence number of the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.

subDetailSequence

PositiveIntType subDetailSequence

The sequence number of the sub-detail within the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.

Class org.hl7.fhir.r4.model.ClaimResponse.InsuranceComponent

class InsuranceComponent extends BackboneElement implements Serializable

serialVersionUID:

282380584L

Serialized Fields

businessArrangement

StringType businessArrangement

A business agreement number established between the provider and the insurer for special business processing purposes.

claimResponse

Reference claimResponse

The result of the adjudication of the line items for the Coverage specified in this insurance.

claimResponseTarget

ClaimResponse claimResponseTarget

The actual object that is the target of the reference (The result of the adjudication of the line items for the Coverage specified in this insurance.)

coverage

Reference coverage

Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.

coverageTarget

Coverage coverageTarget

The actual object that is the target of the reference (Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.)

focal

BooleanType focal

A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.

sequence

PositiveIntType sequence

A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.

Class org.hl7.fhir.r4.model.ClaimResponse.ItemComponent

class ItemComponent extends BackboneElement implements Serializable

serialVersionUID:

701277928L

Serialized Fields

adjudication

List<ClaimResponse.AdjudicationComponent> adjudication

If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.

detail

List<ClaimResponse.ItemDetailComponent> detail

A claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

itemSequence

PositiveIntType itemSequence

A number to uniquely reference the claim item entries.

noteNumber

List<PositiveIntType> noteNumber

The numbers associated with notes below which apply to the adjudication of this item.

Class org.hl7.fhir.r4.model.ClaimResponse.ItemDetailComponent

class ItemDetailComponent extends BackboneElement implements Serializable

serialVersionUID:

1066636111L

Serialized Fields

adjudication

List<ClaimResponse.AdjudicationComponent> adjudication

The adjudication results.

detailSequence

PositiveIntType detailSequence

A number to uniquely reference the claim detail entry.

noteNumber

List<PositiveIntType> noteNumber

The numbers associated with notes below which apply to the adjudication of this item.

subDetail

List<ClaimResponse.SubDetailComponent> subDetail

A sub-detail adjudication of a simple product or service.

Class org.hl7.fhir.r4.model.ClaimResponse.NoteComponent

class NoteComponent extends BackboneElement implements Serializable

serialVersionUID:

-385184277L

Serialized Fields

language

CodeableConcept language

A code to define the language used in the text of the note.

number

PositiveIntType number

A number to uniquely identify a note entry.

text

StringType text

The explanation or description associated with the processing.

type

Enumeration<Enumerations.NoteType> type

The business purpose of the note text.

Class org.hl7.fhir.r4.model.ClaimResponse.PaymentComponent

class PaymentComponent extends BackboneElement implements Serializable

serialVersionUID:

1539906026L

Serialized Fields

adjustment

Money adjustment

Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication.

adjustmentReason

CodeableConcept adjustmentReason

Reason for the payment adjustment.

amount

Money amount

Benefits payable less any payment adjustment.

date

DateType date

Estimated date the payment will be issued or the actual issue date of payment.

identifier

Identifier identifier

Issuer's unique identifier for the payment instrument.

type

CodeableConcept type

Whether this represents partial or complete payment of the benefits payable.

Class org.hl7.fhir.r4.model.ClaimResponse.RemittanceOutcomeEnumFactory

class RemittanceOutcomeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ClaimResponse.SubDetailComponent

class SubDetailComponent extends BackboneElement implements Serializable

serialVersionUID:

-1083724362L

Serialized Fields

adjudication

List<ClaimResponse.AdjudicationComponent> adjudication

The adjudication results.

noteNumber

List<PositiveIntType> noteNumber

The numbers associated with notes below which apply to the adjudication of this item.

subDetailSequence

PositiveIntType subDetailSequence

A number to uniquely reference the claim sub-detail entry.

Class org.hl7.fhir.r4.model.ClaimResponse.TotalComponent

class TotalComponent extends BackboneElement implements Serializable

serialVersionUID:

2012310309L

Serialized Fields

amount

Money amount

Monetary total amount associated with the category.

category

CodeableConcept category

A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

Class org.hl7.fhir.r4.model.ClaimResponse.UseEnumFactory

class UseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ClinicalImpression

class ClinicalImpression extends DomainResource implements Serializable

serialVersionUID:

1158874575L

Serialized Fields

assessor

Reference assessor

The clinician performing the assessment.

assessorTarget

Resource assessorTarget

The actual object that is the target of the reference (The clinician performing the assessment.)

code

CodeableConcept code

Categorizes the type of clinical assessment performed.

date

DateTimeType date

Indicates when the documentation of the assessment was complete.

description

StringType description

A summary of the context and/or cause of the assessment - why / where it was performed, and what patient events/status prompted it.

effective

Type effective

The point in time or period over which the subject was assessed.

encounter

Reference encounter

The Encounter during which this ClinicalImpression was created or to which the creation of this record is tightly associated.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (The Encounter during which this ClinicalImpression was created or to which the creation of this record is tightly associated.)

finding

List<ClinicalImpression.ClinicalImpressionFindingComponent> finding

Specific findings or diagnoses that were considered likely or relevant to ongoing treatment.

identifier

List<Identifier> identifier

Business identifiers assigned to this clinical impression by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

investigation

List<ClinicalImpression.ClinicalImpressionInvestigationComponent> investigation

One or more sets of investigations (signs, symptoms, etc.). The actual grouping of investigations varies greatly depending on the type and context of the assessment. These investigations may include data generated during the assessment process, or data previously generated and recorded that is pertinent to the outcomes.

note

List<Annotation> note

Commentary about the impression, typically recorded after the impression itself was made, though supplemental notes by the original author could also appear.

previous

Reference previous

A reference to the last assessment that was conducted on this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes.

previousTarget

ClinicalImpression previousTarget

The actual object that is the target of the reference (A reference to the last assessment that was conducted on this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes.)

problem

List<Reference> problem

A list of the relevant problems/conditions for a patient.

problemTarget

List<Resource> problemTarget

The actual objects that are the target of the reference (A list of the relevant problems/conditions for a patient.)

prognosisCodeableConcept

List<CodeableConcept> prognosisCodeableConcept

Estimate of likely outcome.

prognosisReference

List<Reference> prognosisReference

RiskAssessment expressing likely outcome.

prognosisReferenceTarget

List<RiskAssessment> prognosisReferenceTarget

The actual objects that are the target of the reference (RiskAssessment expressing likely outcome.)

protocol

List<UriType> protocol

Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis.

status

Enumeration<ClinicalImpression.ClinicalImpressionStatus> status

Identifies the workflow status of the assessment.

statusReason

CodeableConcept statusReason

Captures the reason for the current state of the ClinicalImpression.

subject

Reference subject

The patient or group of individuals assessed as part of this record.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (The patient or group of individuals assessed as part of this record.)

summary

StringType summary

A text summary of the investigations and the diagnosis.

supportingInfo

List<Reference> supportingInfo

Information supporting the clinical impression.

supportingInfoTarget

List<Resource> supportingInfoTarget

The actual objects that are the target of the reference (Information supporting the clinical impression.)

Class org.hl7.fhir.r4.model.ClinicalImpression.ClinicalImpressionFindingComponent

class ClinicalImpressionFindingComponent extends BackboneElement implements Serializable

serialVersionUID:

-1578446448L

Serialized Fields

basis

StringType basis

Which investigations support finding or diagnosis.

itemCodeableConcept

CodeableConcept itemCodeableConcept

Specific text or code for finding or diagnosis, which may include ruled-out or resolved conditions.

itemReference

Reference itemReference

Specific reference for finding or diagnosis, which may include ruled-out or resolved conditions.

itemReferenceTarget

Resource itemReferenceTarget

The actual object that is the target of the reference (Specific reference for finding or diagnosis, which may include ruled-out or resolved conditions.)

Class org.hl7.fhir.r4.model.ClinicalImpression.ClinicalImpressionInvestigationComponent

class ClinicalImpressionInvestigationComponent extends BackboneElement implements Serializable

serialVersionUID:

-301363326L

Serialized Fields

code

CodeableConcept code

A name/code for the group ("set") of investigations. Typically, this will be something like "signs", "symptoms", "clinical", "diagnostic", but the list is not constrained, and others such groups such as (exposure|family|travel|nutritional) history may be used.

item

List<Reference> item

A record of a specific investigation that was undertaken.

itemTarget

List<Resource> itemTarget

The actual objects that are the target of the reference (A record of a specific investigation that was undertaken.)

Class org.hl7.fhir.r4.model.ClinicalImpression.ClinicalImpressionStatusEnumFactory

class ClinicalImpressionStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CodeableConcept

class CodeableConcept extends Type implements Serializable

serialVersionUID:

760353246L

Serialized Fields

coding

List<Coding> coding

A reference to a code defined by a terminology system.

text

StringType text

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Class org.hl7.fhir.r4.model.CodeSystem

class CodeSystem extends MetadataResource implements Serializable

serialVersionUID:

-1735124584L

Serialized Fields

caseSensitive

BooleanType caseSensitive

If code comparison is case sensitive when codes within this system are compared to each other.

compositional

BooleanType compositional

The code system defines a compositional (post-coordination) grammar.

concept

List<CodeSystem.ConceptDefinitionComponent> concept

Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are.

content

Enumeration<CodeSystem.CodeSystemContentMode> content

The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.

copyright

MarkdownType copyright

A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.

count

UnsignedIntType count

The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward.

filter

List<CodeSystem.CodeSystemFilterComponent> filter

A filter that can be used in a value set compose statement when selecting concepts using a filter.

hierarchyMeaning

Enumeration<CodeSystem.CodeSystemHierarchyMeaning> hierarchyMeaning

The meaning of the hierarchy of concepts as represented in this resource.

identifier

List<Identifier> identifier

A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.

property

List<CodeSystem.PropertyComponent> property

A property defines an additional slot through which additional information can be provided about a concept.

purpose

MarkdownType purpose

Explanation of why this code system is needed and why it has been designed as it has.

supplements

CanonicalType supplements

The canonical URL of the code system that this code system supplement is adding designations and properties to.

valueSet

CanonicalType valueSet

Canonical reference to the value set that contains the entire code system.

versionNeeded

BooleanType versionNeeded

This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system.

Class org.hl7.fhir.r4.model.CodeSystem.CodeSystemContentModeEnumFactory

class CodeSystemContentModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CodeSystem.CodeSystemFilterComponent

class CodeSystemFilterComponent extends BackboneElement implements Serializable

serialVersionUID:

-1087409836L

Serialized Fields

code

CodeType code

The code that identifies this filter when it is used as a filter in [[[ValueSet]]].compose.include.filter.

description

StringType description

A description of how or why the filter is used.

operator

List<Enumeration<CodeSystem.FilterOperator>> operator

A list of operators that can be used with the filter.

value

StringType value

A description of what the value for the filter should be.

Class org.hl7.fhir.r4.model.CodeSystem.CodeSystemHierarchyMeaningEnumFactory

class CodeSystemHierarchyMeaningEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CodeSystem.ConceptDefinitionComponent

class ConceptDefinitionComponent extends BackboneElement implements Serializable

serialVersionUID:

878320988L

Serialized Fields

code

CodeType code

A code - a text symbol - that uniquely identifies the concept within the code system.

concept

List<CodeSystem.ConceptDefinitionComponent> concept

Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) - see hierarchyMeaning.

definition

StringType definition

The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.

designation

List<CodeSystem.ConceptDefinitionDesignationComponent> designation

Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.

display

StringType display

A human readable string that is the recommended default way to present this concept to a user.

property

List<CodeSystem.ConceptPropertyComponent> property

A property value for this concept.

Class org.hl7.fhir.r4.model.CodeSystem.ConceptDefinitionDesignationComponent

class ConceptDefinitionDesignationComponent extends BackboneElement implements Serializable

serialVersionUID:

1515662414L

Serialized Fields

language

CodeType language

The language this designation is defined for.

use

Coding use

A code that details how this designation would be used.

value

StringType value

The text value for this designation.

Class org.hl7.fhir.r4.model.CodeSystem.ConceptPropertyComponent

class ConceptPropertyComponent extends BackboneElement implements Serializable

serialVersionUID:

1742812311L

Serialized Fields

code

CodeType code

A code that is a reference to CodeSystem.property.code.

value

Type value

The value of this property.

Class org.hl7.fhir.r4.model.CodeSystem.FilterOperatorEnumFactory

class FilterOperatorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CodeSystem.PropertyComponent

class PropertyComponent extends BackboneElement implements Serializable

serialVersionUID:

-1810713373L

Serialized Fields

code

CodeType code

A code that is used to identify the property. The code is used internally (in CodeSystem.concept.property.code) and also externally, such as in property filters.

description

StringType description

A description of the property- why it is defined, and how its value might be used.

type

Enumeration<CodeSystem.PropertyType> type

The type of the property value. Properties of type "code" contain a code defined by the code system (e.g. a reference to another defined concept).

uri

UriType uri

Reference to the formal meaning of the property. One possible source of meaning is the [Concept Properties](codesystem-concept-properties.html) code system.

Class org.hl7.fhir.r4.model.CodeSystem.PropertyTypeEnumFactory

class PropertyTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CodeType

class CodeType extends StringType implements Externalizable

serialVersionUID:

3L

Serialization Methods

readExternal

public void readExternal(ObjectInput theIn)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput theOut)
                   throws IOException

Throws:

IOException

Class org.hl7.fhir.r4.model.Coding

class Coding extends Type implements Serializable

serialVersionUID:

-1417514061L

Serialized Fields

code

CodeType code

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

display

StringType display

A representation of the meaning of the code in the system, following the rules of the system.

system

UriType system

The identification of the code system that defines the meaning of the symbol in the code.

userSelected

BooleanType userSelected

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

version

StringType version

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Class org.hl7.fhir.r4.model.Communication

class Communication extends DomainResource implements Serializable

serialVersionUID:

1325359310L

Serialized Fields

about

List<Reference> about

Other resources that pertain to this communication and to which this communication should be associated.

aboutTarget

List<Resource> aboutTarget

The actual objects that are the target of the reference (Other resources that pertain to this communication and to which this communication should be associated.)

basedOn

List<Reference> basedOn

An order, proposal or plan fulfilled in whole or in part by this Communication.

basedOnTarget

List<Resource> basedOnTarget

The actual objects that are the target of the reference (An order, proposal or plan fulfilled in whole or in part by this Communication.)

category

List<CodeableConcept> category

The type of message conveyed such as alert, notification, reminder, instruction, etc.

encounter

Reference encounter

The Encounter during which this Communication was created or to which the creation of this record is tightly associated.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (The Encounter during which this Communication was created or to which the creation of this record is tightly associated.)

identifier

List<Identifier> identifier

Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

inResponseTo

List<Reference> inResponseTo

Prior communication that this communication is in response to.

inResponseToTarget

List<Communication> inResponseToTarget

The actual objects that are the target of the reference (Prior communication that this communication is in response to.)

instantiatesCanonical

List<CanonicalType> instantiatesCanonical

The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.

instantiatesUri

List<UriType> instantiatesUri

The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.

medium

List<CodeableConcept> medium

A channel that was used for this communication (e.g. email, fax).

note

List<Annotation> note

Additional notes or commentary about the communication by the sender, receiver or other interested parties.

partOf

List<Reference> partOf

Part of this action.

partOfTarget

List<Resource> partOfTarget

The actual objects that are the target of the reference (Part of this action.)

payload

List<Communication.CommunicationPayloadComponent> payload

Text, attachment(s), or resource(s) that was communicated to the recipient.

priority

Enumeration<Communication.CommunicationPriority> priority

Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.

reasonCode

List<CodeableConcept> reasonCode

The reason or justification for the communication.

reasonReference

List<Reference> reasonReference

Indicates another resource whose existence justifies this communication.

reasonReferenceTarget

List<Resource> reasonReferenceTarget

The actual objects that are the target of the reference (Indicates another resource whose existence justifies this communication.)

received

DateTimeType received

The time when this communication arrived at the destination.

recipient

List<Reference> recipient

The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).

recipientTarget

List<Resource> recipientTarget

The actual objects that are the target of the reference (The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).)

sender

Reference sender

The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.

senderTarget

Resource senderTarget

The actual object that is the target of the reference (The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.)

sent

DateTimeType sent

The time when this communication was sent.

status

Enumeration<Communication.CommunicationStatus> status

The status of the transmission.

statusReason

CodeableConcept statusReason

Captures the reason for the current state of the Communication.

subject

Reference subject

The patient or group that was the focus of this communication.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (The patient or group that was the focus of this communication.)

topic

CodeableConcept topic

Description of the purpose/content, similar to a subject line in an email.

Class org.hl7.fhir.r4.model.Communication.CommunicationPayloadComponent

class CommunicationPayloadComponent extends BackboneElement implements Serializable

serialVersionUID:

-1763459053L

Serialized Fields

content

Type content

A communicated content (or for multi-part communications, one portion of the communication).

Class org.hl7.fhir.r4.model.Communication.CommunicationPriorityEnumFactory

class CommunicationPriorityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Communication.CommunicationStatusEnumFactory

class CommunicationStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CommunicationRequest

class CommunicationRequest extends DomainResource implements Serializable

serialVersionUID:

2131096857L

Serialized Fields

about

List<Reference> about

Other resources that pertain to this communication request and to which this communication request should be associated.

aboutTarget

List<Resource> aboutTarget

The actual objects that are the target of the reference (Other resources that pertain to this communication request and to which this communication request should be associated.)

authoredOn

DateTimeType authoredOn

For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.

basedOn

List<Reference> basedOn

A plan or proposal that is fulfilled in whole or in part by this request.

basedOnTarget

List<Resource> basedOnTarget

The actual objects that are the target of the reference (A plan or proposal that is fulfilled in whole or in part by this request.)

category

List<CodeableConcept> category

The type of message to be sent such as alert, notification, reminder, instruction, etc.

doNotPerform

BooleanType doNotPerform

If true indicates that the CommunicationRequest is asking for the specified action to *not* occur.

encounter

Reference encounter

The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.)

groupIdentifier

Identifier groupIdentifier

A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.

identifier

List<Identifier> identifier

Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

medium

List<CodeableConcept> medium

A channel that was used for this communication (e.g. email, fax).

note

List<Annotation> note

Comments made about the request by the requester, sender, recipient, subject or other participants.

occurrence

Type occurrence

The time when this communication is to occur.

payload

List<CommunicationRequest.CommunicationRequestPayloadComponent> payload

Text, attachment(s), or resource(s) to be communicated to the recipient.

priority

Enumeration<CommunicationRequest.CommunicationPriority> priority

Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.

reasonCode

List<CodeableConcept> reasonCode

Describes why the request is being made in coded or textual form.

reasonReference

List<Reference> reasonReference

Indicates another resource whose existence justifies this request.

reasonReferenceTarget

List<Resource> reasonReferenceTarget

The actual objects that are the target of the reference (Indicates another resource whose existence justifies this request.)

recipient

List<Reference> recipient

The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.

recipientTarget

List<Resource> recipientTarget

The actual objects that are the target of the reference (The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.)

replaces

List<Reference> replaces

Completed or terminated request(s) whose function is taken by this new request.

replacesTarget

List<CommunicationRequest> replacesTarget

The actual objects that are the target of the reference (Completed or terminated request(s) whose function is taken by this new request.)

requester

Reference requester

The device, individual, or organization who initiated the request and has responsibility for its activation.

requesterTarget

Resource requesterTarget

The actual object that is the target of the reference (The device, individual, or organization who initiated the request and has responsibility for its activation.)

sender

Reference sender

The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.

senderTarget

Resource senderTarget

The actual object that is the target of the reference (The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.)

status

Enumeration<CommunicationRequest.CommunicationRequestStatus> status

The status of the proposal or order.

statusReason

CodeableConcept statusReason

Captures the reason for the current state of the CommunicationRequest.

subject

Reference subject

The patient or group that is the focus of this communication request.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (The patient or group that is the focus of this communication request.)

Class org.hl7.fhir.r4.model.CommunicationRequest.CommunicationPriorityEnumFactory

class CommunicationPriorityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CommunicationRequest.CommunicationRequestPayloadComponent

class CommunicationRequestPayloadComponent extends BackboneElement implements Serializable

serialVersionUID:

-1763459053L

Serialized Fields

content

Type content

The communicated content (or for multi-part communications, one portion of the communication).

Class org.hl7.fhir.r4.model.CommunicationRequest.CommunicationRequestStatusEnumFactory

class CommunicationRequestStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CompartmentDefinition

class CompartmentDefinition extends MetadataResource implements Serializable

serialVersionUID:

-1159172945L

Serialized Fields

code

Enumeration<CompartmentDefinition.CompartmentType> code

Which compartment this definition describes.

purpose

MarkdownType purpose

Explanation of why this compartment definition is needed and why it has been designed as it has.

resource

List<CompartmentDefinition.CompartmentDefinitionResourceComponent> resource

Information about how a resource is related to the compartment.

search

BooleanType search

Whether the search syntax is supported,.

Class org.hl7.fhir.r4.model.CompartmentDefinition.CompartmentDefinitionResourceComponent

class CompartmentDefinitionResourceComponent extends BackboneElement implements Serializable

serialVersionUID:

988080897L

Serialized Fields

code

CodeType code

The name of a resource supported by the server.

documentation

StringType documentation

Additional documentation about the resource and compartment.

param

List<StringType> param

The name of a search parameter that represents the link to the compartment. More than one may be listed because a resource may be linked to a compartment in more than one way,.

Class org.hl7.fhir.r4.model.CompartmentDefinition.CompartmentTypeEnumFactory

class CompartmentTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Composition

class Composition extends DomainResource implements Serializable

serialVersionUID:

-1490206663L

Serialized Fields

attester

List<Composition.CompositionAttesterComponent> attester

A participant who has attested to the accuracy of the composition/document.

author

List<Reference> author

Identifies who is responsible for the information in the composition, not necessarily who typed it in.

authorTarget

List<Resource> authorTarget

The actual objects that are the target of the reference (Identifies who is responsible for the information in the composition, not necessarily who typed it in.)

category

List<CodeableConcept> category

A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.

confidentiality

Enumeration<Composition.DocumentConfidentiality> confidentiality

The code specifying the level of confidentiality of the Composition.

custodian

Reference custodian

Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.

custodianTarget

Organization custodianTarget

The actual object that is the target of the reference (Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.)

date

DateTimeType date

The composition editing time, when the composition was last logically changed by the author.

encounter

Reference encounter

Describes the clinical encounter or type of care this documentation is associated with.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (Describes the clinical encounter or type of care this documentation is associated with.)

event

List<Composition.CompositionEventComponent> event

The clinical service, such as a colonoscopy or an appendectomy, being documented.

identifier

Identifier identifier

A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.

relatesTo

List<Composition.CompositionRelatesToComponent> relatesTo

Relationships that this composition has with other compositions or documents that already exist.

section

List<Composition.SectionComponent> section

The root of the sections that make up the composition.

status

Enumeration<Composition.CompositionStatus> status

The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.

subject

Reference subject

Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).)

title

StringType title

Official human-readable label for the composition.

type

CodeableConcept type

Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.

Class org.hl7.fhir.r4.model.Composition.CompositionAttestationModeEnumFactory

class CompositionAttestationModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Composition.CompositionAttesterComponent

class CompositionAttesterComponent extends BackboneElement implements Serializable

serialVersionUID:

-1917768205L

Serialized Fields

mode

Enumeration<Composition.CompositionAttestationMode> mode

The type of attestation the authenticator offers.

party

Reference party

Who attested the composition in the specified way.

partyTarget

Resource partyTarget

The actual object that is the target of the reference (Who attested the composition in the specified way.)

time

DateTimeType time

When the composition was attested by the party.

Class org.hl7.fhir.r4.model.Composition.CompositionEventComponent

class CompositionEventComponent extends BackboneElement implements Serializable

serialVersionUID:

-1581379774L

Serialized Fields

code

List<CodeableConcept> code

This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.

detail

List<Reference> detail

The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.

detailTarget

List<Resource> detailTarget

The actual objects that are the target of the reference (The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.)

period

Period period

The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.

Class org.hl7.fhir.r4.model.Composition.CompositionRelatesToComponent

class CompositionRelatesToComponent extends BackboneElement implements Serializable

serialVersionUID:

1536930280L

Serialized Fields

code

Enumeration<Composition.DocumentRelationshipType> code

The type of relationship that this composition has with anther composition or document.

target

Type target

The target composition/document of this relationship.

Class org.hl7.fhir.r4.model.Composition.CompositionStatusEnumFactory

class CompositionStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Composition.DocumentConfidentialityEnumFactory

class DocumentConfidentialityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Composition.DocumentRelationshipTypeEnumFactory

class DocumentRelationshipTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Composition.SectionComponent

class SectionComponent extends BackboneElement implements Serializable

serialVersionUID:

-797396954L

Serialized Fields

author

List<Reference> author

Identifies who is responsible for the information in this section, not necessarily who typed it in.

authorTarget

List<Resource> authorTarget

The actual objects that are the target of the reference (Identifies who is responsible for the information in this section, not necessarily who typed it in.)

code

CodeableConcept code

A code identifying the kind of content contained within the section. This must be consistent with the section title.

emptyReason

CodeableConcept emptyReason

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

entry

List<Reference> entry

A reference to the actual resource from which the narrative in the section is derived.

entryTarget

List<Resource> entryTarget

The actual objects that are the target of the reference (A reference to the actual resource from which the narrative in the section is derived.)

focus

Reference focus

The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).

focusTarget

Resource focusTarget

The actual object that is the target of the reference (The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).)

mode

Enumeration<Composition.SectionMode> mode

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

orderedBy

CodeableConcept orderedBy

Specifies the order applied to the items in the section entries.

section

List<Composition.SectionComponent> section

A nested sub-section within this section.

text

Narrative text

A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.

title

StringType title

The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.

Class org.hl7.fhir.r4.model.Composition.SectionModeEnumFactory

class SectionModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ConceptMap

class ConceptMap extends MetadataResource implements Serializable

serialVersionUID:

-2081872580L

Serialized Fields

copyright

MarkdownType copyright

A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map.

group

List<ConceptMap.ConceptMapGroupComponent> group

A group of mappings that all have the same source and target system.

identifier

Identifier identifier

A formal identifier that is used to identify this concept map when it is represented in other formats, or referenced in a specification, model, design or an instance.

purpose

MarkdownType purpose

Explanation of why this concept map is needed and why it has been designed as it has.

source

Type source

Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings.

target

Type target

The target value set provides context for the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.

Class org.hl7.fhir.r4.model.ConceptMap.ConceptMapGroupComponent

class ConceptMapGroupComponent extends BackboneElement implements Serializable

serialVersionUID:

1606357508L

Serialized Fields

element

List<ConceptMap.SourceElementComponent> element

Mappings for an individual concept in the source to one or more concepts in the target.

source

UriType source

An absolute URI that identifies the source system where the concepts to be mapped are defined.

sourceVersion

StringType sourceVersion

The specific version of the code system, as determined by the code system authority.

target

UriType target

An absolute URI that identifies the target system that the concepts will be mapped to.

targetVersion

StringType targetVersion

The specific version of the code system, as determined by the code system authority.

unmapped

ConceptMap.ConceptMapGroupUnmappedComponent unmapped

What to do when there is no mapping for the source concept. "Unmapped" does not include codes that are unmatched, and the unmapped element is ignored in a code is specified to have equivalence = unmatched.

Class org.hl7.fhir.r4.model.ConceptMap.ConceptMapGroupUnmappedComponent

class ConceptMapGroupUnmappedComponent extends BackboneElement implements Serializable

serialVersionUID:

1261364354L

Serialized Fields

code

CodeType code

The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code.

display

StringType display

The display for the code. The display is only provided to help editors when editing the concept map.

mode

Enumeration<ConceptMap.ConceptMapGroupUnmappedMode> mode

Defines which action to take if there is no match for the source concept in the target system designated for the group. One of 3 actions are possible: use the unmapped code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL).

url

CanonicalType url

The canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source concept.

Class org.hl7.fhir.r4.model.ConceptMap.ConceptMapGroupUnmappedModeEnumFactory

class ConceptMapGroupUnmappedModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ConceptMap.OtherElementComponent

class OtherElementComponent extends BackboneElement implements Serializable

serialVersionUID:

-1836341923L

Serialized Fields

display

StringType display

The display for the code. The display is only provided to help editors when editing the concept map.

property

UriType property

A reference to an element that holds a coded value that corresponds to a code system property. The idea is that the information model carries an element somewhere that is labeled to correspond with a code system property.

system

CanonicalType system

An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that crosses code systems).

value

StringType value

Identity (code or path) or the element/item/ValueSet/text that the map depends on / refers to.

Class org.hl7.fhir.r4.model.ConceptMap.SourceElementComponent

class SourceElementComponent extends BackboneElement implements Serializable

serialVersionUID:

-1115258852L

Serialized Fields

code

CodeType code

Identity (code or path) or the element/item being mapped.

display

StringType display

The display for the code. The display is only provided to help editors when editing the concept map.

target

List<ConceptMap.TargetElementComponent> target

A concept from the target value set that this concept maps to.

Class org.hl7.fhir.r4.model.ConceptMap.TargetElementComponent

class TargetElementComponent extends BackboneElement implements Serializable

serialVersionUID:

-2008997477L

Serialized Fields

code

CodeType code

Identity (code or path) or the element/item that the map refers to.

comment

StringType comment

A description of status/issues in mapping that conveys additional information not represented in the structured data.

dependsOn

List<ConceptMap.OtherElementComponent> dependsOn

A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element can be resolved, and it has the specified value.

display

StringType display

The display for the code. The display is only provided to help editors when editing the concept map.

equivalence

Enumeration<Enumerations.ConceptMapEquivalence> equivalence

The equivalence between the source and target concepts (counting for the dependencies and products). The equivalence is read from target to source (e.g. the target is 'wider' than the source).

product

List<ConceptMap.OtherElementComponent> product

A set of additional outcomes from this mapping to other elements. To properly execute this mapping, the specified element must be mapped to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but the equivalence cannot be relied on.

Class org.hl7.fhir.r4.model.Condition

class Condition extends DomainResource implements Serializable

serialVersionUID:

186776568L

Serialized Fields

abatement

Type abatement

The date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" - Conditions are never really resolved, but they can abate.

asserter

Reference asserter

Individual who is making the condition statement.

asserterTarget

Resource asserterTarget

The actual object that is the target of the reference (Individual who is making the condition statement.)

bodySite

List<CodeableConcept> bodySite

The anatomical location where this condition manifests itself.

category

List<CodeableConcept> category

A category assigned to the condition.

clinicalStatus

CodeableConcept clinicalStatus

The clinical status of the condition.

code

CodeableConcept code

Identification of the condition, problem or diagnosis.

encounter

Reference encounter

The Encounter during which this Condition was created or to which the creation of this record is tightly associated.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (The Encounter during which this Condition was created or to which the creation of this record is tightly associated.)

evidence

List<Condition.ConditionEvidenceComponent> evidence

Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.

identifier

List<Identifier> identifier

Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

note

List<Annotation> note

Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.

onset

Type onset

Estimated or actual date or date-time the condition began, in the opinion of the clinician.

recordedDate

DateTimeType recordedDate

The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.

recorder

Reference recorder

Individual who recorded the record and takes responsibility for its content.

recorderTarget

Resource recorderTarget

The actual object that is the target of the reference (Individual who recorded the record and takes responsibility for its content.)

severity

CodeableConcept severity

A subjective assessment of the severity of the condition as evaluated by the clinician.

stage

List<Condition.ConditionStageComponent> stage

Clinical stage or grade of a condition. May include formal severity assessments.

subject

Reference subject

Indicates the patient or group who the condition record is associated with.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (Indicates the patient or group who the condition record is associated with.)

verificationStatus

CodeableConcept verificationStatus

The verification status to support the clinical status of the condition.

Class org.hl7.fhir.r4.model.Condition.ConditionEvidenceComponent

class ConditionEvidenceComponent extends BackboneElement implements Serializable

serialVersionUID:

1135831276L

Serialized Fields

code

List<CodeableConcept> code

A manifestation or symptom that led to the recording of this condition.

detail

List<Reference> detail

Links to other relevant information, including pathology reports.

detailTarget

List<Resource> detailTarget

The actual objects that are the target of the reference (Links to other relevant information, including pathology reports.)

Class org.hl7.fhir.r4.model.Condition.ConditionStageComponent

class ConditionStageComponent extends BackboneElement implements Serializable

serialVersionUID:

668627986L

Serialized Fields

assessment

List<Reference> assessment

Reference to a formal record of the evidence on which the staging assessment is based.

assessmentTarget

List<Resource> assessmentTarget

The actual objects that are the target of the reference (Reference to a formal record of the evidence on which the staging assessment is based.)

summary

CodeableConcept summary

A simple summary of the stage such as "Stage 3". The determination of the stage is disease-specific.

type

CodeableConcept type

The kind of staging, such as pathological or clinical staging.

Class org.hl7.fhir.r4.model.Consent

class Consent extends DomainResource implements Serializable

serialVersionUID:

206528051L

Serialized Fields

category

List<CodeableConcept> category

A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.

dateTime

DateTimeType dateTime

When this Consent was issued / created / indexed.

identifier

List<Identifier> identifier

Unique identifier for this copy of the Consent Statement.

organization

List<Reference> organization

The organization that manages the consent, and the framework within which it is executed.

organizationTarget

List<Organization> organizationTarget

The actual objects that are the target of the reference (The organization that manages the consent, and the framework within which it is executed.)

patient

Reference patient

The patient/healthcare consumer to whom this consent applies.

patientTarget

Patient patientTarget

The actual object that is the target of the reference (The patient/healthcare consumer to whom this consent applies.)

performer

List<Reference> performer

Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.

performerTarget

List<Resource> performerTarget

The actual objects that are the target of the reference (Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.)

policy

List<Consent.ConsentPolicyComponent> policy

The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.

policyRule

CodeableConcept policyRule

A reference to the specific base computable regulation or policy.

provision

Consent.provisionComponent provision

An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.

scope

CodeableConcept scope

A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible.

source

Type source

The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.

status

Enumeration<Consent.ConsentState> status

Indicates the current state of this consent.

verification

List<Consent.ConsentVerificationComponent> verification

Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.

Class org.hl7.fhir.r4.model.Consent.ConsentDataMeaningEnumFactory

class ConsentDataMeaningEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Consent.ConsentPolicyComponent

class ConsentPolicyComponent extends BackboneElement implements Serializable

serialVersionUID:

672275705L

Serialized Fields

authority

UriType authority

Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives.

uri

UriType uri

The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.

Class org.hl7.fhir.r4.model.Consent.ConsentProvisionTypeEnumFactory

class ConsentProvisionTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Consent.ConsentStateEnumFactory

class ConsentStateEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Consent.ConsentVerificationComponent

class ConsentVerificationComponent extends BackboneElement implements Serializable

serialVersionUID:

1305161458L

Serialized Fields

verificationDate

DateTimeType verificationDate

Date verification was collected.

verified

BooleanType verified

Has the instruction been verified.

verifiedWith

Reference verifiedWith

Who verified the instruction (Patient, Relative or other Authorized Person).

verifiedWithTarget

Resource verifiedWithTarget

The actual object that is the target of the reference (Who verified the instruction (Patient, Relative or other Authorized Person).)

Class org.hl7.fhir.r4.model.Consent.provisionActorComponent

class provisionActorComponent extends BackboneElement implements Serializable

serialVersionUID:

1152919415L

Serialized Fields

reference

Reference reference

The resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers').

referenceTarget

Resource referenceTarget

The actual object that is the target of the reference (The resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers').)

role

CodeableConcept role

How the individual is involved in the resources content that is described in the exception.

Class org.hl7.fhir.r4.model.Consent.provisionComponent

class provisionComponent extends BackboneElement implements Serializable

serialVersionUID:

-1280172451L

Serialized Fields

action

List<CodeableConcept> action

Actions controlled by this Rule.

actor

List<Consent.provisionActorComponent> actor

Who or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').

class_

List<Coding> class_

The class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to.

code

List<CodeableConcept> code

If this code is found in an instance, then the rule applies.

data

List<Consent.provisionDataComponent> data

The resources controlled by this rule if specific resources are referenced.

dataPeriod

Period dataPeriod

Clinical or Operational Relevant period of time that bounds the data controlled by this rule.

period

Period period

The timeframe in this rule is valid.

provision

List<Consent.provisionComponent> provision

Rules which provide exceptions to the base rule or subrules.

purpose

List<Coding> purpose

The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule.

securityLabel

List<Coding> securityLabel

A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.

type

Enumeration<Consent.ConsentProvisionType> type

Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules.

Class org.hl7.fhir.r4.model.Consent.provisionDataComponent

class provisionDataComponent extends BackboneElement implements Serializable

serialVersionUID:

-424898645L

Serialized Fields

meaning

Enumeration<Consent.ConsentDataMeaning> meaning

How the resource reference is interpreted when testing consent restrictions.

reference

Reference reference

A reference to a specific resource that defines which resources are covered by this consent.

referenceTarget

Resource referenceTarget

The actual object that is the target of the reference (A reference to a specific resource that defines which resources are covered by this consent.)

Class org.hl7.fhir.r4.model.ContactDetail

class ContactDetail extends Type implements Serializable

serialVersionUID:

816838773L

Serialized Fields

name

StringType name

The name of an individual to contact.

telecom

List<ContactPoint> telecom

The contact details for the individual (if a name was provided) or the organization.

Class org.hl7.fhir.r4.model.ContactPoint

class ContactPoint extends Type implements Serializable

serialVersionUID:

1509610874L

Serialized Fields

period

Period period

Time period when the contact point was/is in use.

rank

PositiveIntType rank

Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

system

Enumeration<ContactPoint.ContactPointSystem> system

Telecommunications form for contact point - what communications system is required to make use of the contact.

use

Enumeration<ContactPoint.ContactPointUse> use

Identifies the purpose for the contact point.

value

StringType value

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

Class org.hl7.fhir.r4.model.ContactPoint.ContactPointSystemEnumFactory

class ContactPointSystemEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ContactPoint.ContactPointUseEnumFactory

class ContactPointUseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Contract

class Contract extends DomainResource implements Serializable

serialVersionUID:

-1388892487L

Serialized Fields

alias

List<StringType> alias

Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.g., a domain specific contract number related to legislation.

applies

Period applies

Relevant time or time-period when this Contract is applicable.

author

Reference author

The individual or organization that authored the Contract definition, derivative, or instance in any legal state.

authority

List<Reference> authority

A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.

authorityTarget

List<Organization> authorityTarget

The actual objects that are the target of the reference (A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.)

authorTarget

Resource authorTarget

The actual object that is the target of the reference (The individual or organization that authored the Contract definition, derivative, or instance in any legal state.)

contentDefinition

Contract.ContentDefinitionComponent contentDefinition

Precusory content developed with a focus and intent of supporting the formation a Contract instance, which may be associated with and transformable into a Contract.

contentDerivative

CodeableConcept contentDerivative

The minimal content derived from the basal information source at a specific stage in its lifecycle.

domain

List<Reference> domain

Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.

domainTarget

List<Location> domainTarget

The actual objects that are the target of the reference (Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.)

expirationType

CodeableConcept expirationType

Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract.

friendly

List<Contract.FriendlyLanguageComponent> friendly

The "patient friendly language" versionof the Contract in whole or in parts. "Patient friendly language" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.

identifier

List<Identifier> identifier

Unique identifier for this Contract or a derivative that references a Source Contract.

instantiatesCanonical

Reference instantiatesCanonical

The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.

instantiatesCanonicalTarget

Contract instantiatesCanonicalTarget

The actual object that is the target of the reference (The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.)

instantiatesUri

UriType instantiatesUri

The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.

issued

DateTimeType issued

When this Contract was issued.

legal

List<Contract.LegalLanguageComponent> legal

List of Legal expressions or representations of this Contract.

legallyBinding

Type legallyBinding

Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the "source of truth" and which would be the basis for legal action related to enforcement of this Contract.

legalState

CodeableConcept legalState

Legal states of the formation of a legal instrument, which is a formally executed written document that can be formally attributed to its author, records and formally expresses a legally enforceable act, process, or contractual duty, obligation, or right, and therefore evidences that act, process, or agreement.

name

StringType name

A natural language name identifying this Contract definition, derivative, or instance in any legal state. Provides additional information about its content. This name should be usable as an identifier for the module by machine processing applications such as code generation.

relevantHistory

List<Reference> relevantHistory

Links to Provenance records for past versions of this Contract definition, derivative, or instance, which identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the Contract. The Provence.entity indicates the target that was changed in the update. http://build.fhir.org/provenance-definitions.html#Provenance.entity.

relevantHistoryTarget

List<Provenance> relevantHistoryTarget

The actual objects that are the target of the reference (Links to Provenance records for past versions of this Contract definition, derivative, or instance, which identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the Contract. The Provence.entity indicates the target that was changed in the update. http://build.fhir.org/provenance-definitions.html#Provenance.entity.)

rule

List<Contract.ComputableLanguageComponent> rule

List of Computable Policy Rule Language Representations of this Contract.

scope

CodeableConcept scope

A selector of legal concerns for this Contract definition, derivative, or instance in any legal state.

signer

List<Contract.SignatoryComponent> signer

Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness.

site

List<Reference> site

Sites in which the contract is complied with, exercised, or in force.

siteTarget

List<Location> siteTarget

The actual objects that are the target of the reference (Sites in which the contract is complied with, exercised, or in force.)

status

Enumeration<Contract.ContractStatus> status

The status of the resource instance.

subject

List<Reference> subject

The target entity impacted by or of interest to parties to the agreement.

subjectTarget

List<Resource> subjectTarget

The actual objects that are the target of the reference (The target entity impacted by or of interest to parties to the agreement.)

subtitle

StringType subtitle

An explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.

subType

List<CodeableConcept> subType

Sub-category for the Contract that distinguishes the kinds of systems that would be interested in the Contract within the context of the Contract's scope.

supportingInfo

List<Reference> supportingInfo

Information that may be needed by/relevant to the performer in their execution of this term action.

supportingInfoTarget

List<Resource> supportingInfoTarget

The actual objects that are the target of the reference (Information that may be needed by/relevant to the performer in their execution of this term action.)

term

List<Contract.TermComponent> term

One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.

title

StringType title

A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.

topic

Type topic

Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.

type

CodeableConcept type

A high-level category for the legal instrument, whether constructed as a Contract definition, derivative, or instance in any legal state. Provides additional information about its content within the context of the Contract's scope to distinguish the kinds of systems that would be interested in the contract.

url

UriType url

Canonical identifier for this contract, represented as a URI (globally unique).

version

StringType version

An edition identifier used for business purposes to label business significant variants.

Class org.hl7.fhir.r4.model.Contract.ActionComponent

class ActionComponent extends BackboneElement implements Serializable

serialVersionUID:

-178728180L

Serialized Fields

context

Reference context

Encounter or Episode with primary association to specified term activity.

contextLinkId

List<StringType> contextLinkId

Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.

contextTarget

Resource contextTarget

The actual object that is the target of the reference (Encounter or Episode with primary association to specified term activity.)

doNotPerform

BooleanType doNotPerform

True if the term prohibits the action.

intent

CodeableConcept intent

Reason or purpose for the action stipulated by this Contract Provision.

linkId

List<StringType> linkId

Id [identifier??] of the clause or question text related to this action in the referenced form or QuestionnaireResponse.

note

List<Annotation> note

Comments made about the term action made by the requester, performer, subject or other participants.

occurrence

Type occurrence

When action happens.

performer

Reference performer

Indicates who or what is being asked to perform (or not perform) the ction.

performerLinkId

List<StringType> performerLinkId

Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.

performerRole

CodeableConcept performerRole

The type of role or competency of an individual desired or required to perform or not perform the action.

performerTarget

Resource performerTarget

The actual object that is the target of the reference (Indicates who or what is being asked to perform (or not perform) the ction.)

performerType

List<CodeableConcept> performerType

The type of individual that is desired or required to perform or not perform the action.

reason

List<StringType> reason

Describes why the action is to be performed or not performed in textual form.

reasonCode

List<CodeableConcept> reasonCode

Rationale for the action to be performed or not performed. Describes why the action is permitted or prohibited.

reasonLinkId

List<StringType> reasonLinkId

Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.

reasonReference

List<Reference> reasonReference

Indicates another resource whose existence justifies permitting or not permitting this action.

reasonReferenceTarget

List<Resource> reasonReferenceTarget

The actual objects that are the target of the reference (Indicates another resource whose existence justifies permitting or not permitting this action.)

requester

List<Reference> requester

Who or what initiated the action and has responsibility for its activation.

requesterLinkId

List<StringType> requesterLinkId

Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.

requesterTarget

List<Resource> requesterTarget

The actual objects that are the target of the reference (Who or what initiated the action and has responsibility for its activation.)

securityLabelNumber

List<UnsignedIntType> securityLabelNumber

Security labels that protects the action.

status

CodeableConcept status

Current state of the term action.

subject

List<Contract.ActionSubjectComponent> subject

Entity of the action.

type

CodeableConcept type

Activity or service obligation to be done or not done, performed or not performed, effectuated or not by this Contract term.

Class org.hl7.fhir.r4.model.Contract.ActionSubjectComponent

class ActionSubjectComponent extends BackboneElement implements Serializable

serialVersionUID:

128949255L

Serialized Fields

reference

List<Reference> reference

The entity the action is performed or not performed on or for.

referenceTarget

List<Resource> referenceTarget

The actual objects that are the target of the reference (The entity the action is performed or not performed on or for.)

role

CodeableConcept role

Role type of agent assigned roles in this Contract.

Class org.hl7.fhir.r4.model.Contract.AnswerComponent

class AnswerComponent extends BackboneElement implements Serializable

serialVersionUID:

-732981989L

Serialized Fields

value

Type value

Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.

Class org.hl7.fhir.r4.model.Contract.AssetContextComponent

class AssetContextComponent extends BackboneElement implements Serializable

serialVersionUID:

-634115628L

Serialized Fields

code

List<CodeableConcept> code

Coded representation of the context generally or of the Referenced entity, such as the asset holder type or location.

reference

Reference reference

Asset context reference may include the creator, custodian, or owning Person or Organization (e.g., bank, repository), location held, e.g., building, jurisdiction.

referenceTarget

Resource referenceTarget

The actual object that is the target of the reference (Asset context reference may include the creator, custodian, or owning Person or Organization (e.g., bank, repository), location held, e.g., building, jurisdiction.)

text

StringType text

Context description.

Class org.hl7.fhir.r4.model.Contract.ComputableLanguageComponent

class ComputableLanguageComponent extends BackboneElement implements Serializable

serialVersionUID:

-1763459053L

Serialized Fields

content

Type content

Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal).

Class org.hl7.fhir.r4.model.Contract.ContentDefinitionComponent

class ContentDefinitionComponent extends BackboneElement implements Serializable

serialVersionUID:

-699592864L

Serialized Fields

copyright

MarkdownType copyright

A copyright statement relating to Contract precursor content. Copyright statements are generally legal restrictions on the use and publishing of the Contract precursor content.

publicationDate

DateTimeType publicationDate

The date (and optionally time) when the contract was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the contract changes.

publicationStatus

Enumeration<Contract.ContractPublicationStatus> publicationStatus

amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated.

publisher

Reference publisher

The individual or organization that published the Contract precursor content.

publisherTarget

Resource publisherTarget

The actual object that is the target of the reference (The individual or organization that published the Contract precursor content.)

subType

CodeableConcept subType

Detailed Precusory content type.

type

CodeableConcept type

Precusory content structure and use, i.e., a boilerplate, template, application for a contract such as an insurance policy or benefits under a program, e.g., workers compensation.

Class org.hl7.fhir.r4.model.Contract.ContractAssetComponent

class ContractAssetComponent extends BackboneElement implements Serializable

serialVersionUID:

-1080398792L

Serialized Fields

answer

List<Contract.AnswerComponent> answer

Response to assets.

condition

StringType condition

Description of the quality and completeness of the asset that imay be a factor in its valuation.

context

List<Contract.AssetContextComponent> context

Circumstance of the asset.

linkId

List<StringType> linkId

Id [identifier??] of the clause or question text about the asset in the referenced form or QuestionnaireResponse.

period

List<Period> period

Asset relevant contractual time period.

periodType

List<CodeableConcept> periodType

Type of Asset availability for use or ownership.

relationship

Coding relationship

Specifies the applicability of the term to an asset resource instance, and instances it refers to orinstances that refer to it, and/or are owned by the offeree.

scope

CodeableConcept scope

Differentiates the kind of the asset .

securityLabelNumber

List<UnsignedIntType> securityLabelNumber

Security labels that protects the asset.

subtype

List<CodeableConcept> subtype

May be a subtype or part of an offered asset.

text

StringType text

Clause or question text (Prose Object) concerning the asset in a linked form, such as a QuestionnaireResponse used in the formation of the contract.

type

List<CodeableConcept> type

Target entity type about which the term may be concerned.

typeReference

List<Reference> typeReference

Associated entities.

typeReferenceTarget

List<Resource> typeReferenceTarget

The actual objects that are the target of the reference (Associated entities.)

usePeriod

List<Period> usePeriod

Time period of asset use.

valuedItem

List<Contract.ValuedItemComponent> valuedItem

Contract Valued Item List.

Class org.hl7.fhir.r4.model.Contract.ContractOfferComponent

class ContractOfferComponent extends BackboneElement implements Serializable

serialVersionUID:

-395674449L

Serialized Fields

answer

List<Contract.AnswerComponent> answer

Response to offer text.

decision

CodeableConcept decision

Type of choice made by accepting party with respect to an offer made by an offeror/ grantee.

decisionMode

List<CodeableConcept> decisionMode

How the decision about a Contract was conveyed.

identifier

List<Identifier> identifier

Unique identifier for this particular Contract Provision.

linkId

List<StringType> linkId

The id of the clause or question text of the offer in the referenced questionnaire/response.

party

List<Contract.ContractPartyComponent> party

Offer Recipient.

securityLabelNumber

List<UnsignedIntType> securityLabelNumber

Security labels that protects the offer.

text

StringType text

Human readable form of this Contract Offer.

topic

Reference topic

The owner of an asset has the residual control rights over the asset: the right to decide all usages of the asset in any way not inconsistent with a prior contract, custom, or law (Hart, 1995, p. 30).

topicTarget

Resource topicTarget

The actual object that is the target of the reference (The owner of an asset has the residual control rights over the asset: the right to decide all usages of the asset in any way not inconsistent with a prior contract, custom, or law (Hart, 1995, p. 30).)

type

CodeableConcept type

Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit.

Class org.hl7.fhir.r4.model.Contract.ContractPartyComponent

class ContractPartyComponent extends BackboneElement implements Serializable

serialVersionUID:

128949255L

Serialized Fields

reference

List<Reference> reference

Participant in the offer.

referenceTarget

List<Resource> referenceTarget

The actual objects that are the target of the reference (Participant in the offer.)

role

CodeableConcept role

How the party participates in the offer.

Class org.hl7.fhir.r4.model.Contract.ContractPublicationStatusEnumFactory

class ContractPublicationStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Contract.ContractStatusEnumFactory

class ContractStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Contract.FriendlyLanguageComponent

class FriendlyLanguageComponent extends BackboneElement implements Serializable

serialVersionUID:

-1763459053L

Serialized Fields

content

Type content

Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability.

Class org.hl7.fhir.r4.model.Contract.LegalLanguageComponent

class LegalLanguageComponent extends BackboneElement implements Serializable

serialVersionUID:

-1763459053L

Serialized Fields

content

Type content

Contract legal text in human renderable form.

Class org.hl7.fhir.r4.model.Contract.SecurityLabelComponent

class SecurityLabelComponent extends BackboneElement implements Serializable

serialVersionUID:

788281758L

Serialized Fields

category

List<Coding> category

Security label privacy tag that species the applicable privacy and security policies governing this term and/or term elements.

classification

Coding classification

Security label privacy tag that species the level of confidentiality protection required for this term and/or term elements.

control

List<Coding> control

Security label privacy tag that species the manner in which term and/or term elements are to be protected.

number

List<UnsignedIntType> number

Number used to link this term or term element to the applicable Security Label.

Class org.hl7.fhir.r4.model.Contract.SignatoryComponent

class SignatoryComponent extends BackboneElement implements Serializable

serialVersionUID:

1948139228L

Serialized Fields

party

Reference party

Party which is a signator to this Contract.

partyTarget

Resource partyTarget

The actual object that is the target of the reference (Party which is a signator to this Contract.)

signature

List<Signature> signature

Legally binding Contract DSIG signature contents in Base64.

type

Coding type

Role of this Contract signer, e.g. notary, grantee.

Class org.hl7.fhir.r4.model.Contract.TermComponent

class TermComponent extends BackboneElement implements Serializable

serialVersionUID:

-460907186L

Serialized Fields

action

List<Contract.ActionComponent> action

An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.

applies

Period applies

Relevant time or time-period when this Contract Provision is applicable.

asset

List<Contract.ContractAssetComponent> asset

Contract Term Asset List.

group

List<Contract.TermComponent> group

Nested group of Contract Provisions.

identifier

Identifier identifier

Unique identifier for this particular Contract Provision.

issued

DateTimeType issued

When this Contract Provision was issued.

offer

Contract.ContractOfferComponent offer

The matter of concern in the context of this provision of the agrement.

securityLabel

List<Contract.SecurityLabelComponent> securityLabel

Security labels that protect the handling of information about the term and its elements, which may be specifically identified..

subType

CodeableConcept subType

A specialized legal clause or condition based on overarching contract type.

text

StringType text

Statement of a provision in a policy or a contract.

topic

Type topic

The entity that the term applies to.

type

CodeableConcept type

A legal clause or condition contained within a contract that requires one or both parties to perform a particular requirement by some specified time or prevents one or both parties from performing a particular requirement by some specified time.

Class org.hl7.fhir.r4.model.Contract.ValuedItemComponent

class ValuedItemComponent extends BackboneElement implements Serializable

serialVersionUID:

1894951601L

Serialized Fields

effectiveTime

DateTimeType effectiveTime

Indicates the time during which this Contract ValuedItem information is effective.

entity

Type entity

Specific type of Contract Valued Item that may be priced.

factor

DecimalType factor

A real number that represents a multiplier used in determining the overall value of the Contract Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

identifier

Identifier identifier

Identifies a Contract Valued Item instance.

linkId

List<StringType> linkId

Id of the clause or question text related to the context of this valuedItem in the referenced form or QuestionnaireResponse.

net

Money net

Expresses the product of the Contract Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.

payment

StringType payment

Terms of valuation.

paymentDate

DateTimeType paymentDate

When payment is due.

points

DecimalType points

An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Valued Item delivered. The concept of Points allows for assignment of point values for a Contract Valued Item, such that a monetary amount can be assigned to each point.

quantity

Quantity quantity

Specifies the units by which the Contract Valued Item is measured or counted, and quantifies the countable or measurable Contract Valued Item instances.

recipient

Reference recipient

Who will receive payment.

recipientTarget

Resource recipientTarget

The actual object that is the target of the reference (Who will receive payment.)

responsible

Reference responsible

Who will make payment.

responsibleTarget

Resource responsibleTarget

The actual object that is the target of the reference (Who will make payment.)

securityLabelNumber

List<UnsignedIntType> securityLabelNumber

A set of security labels that define which terms are controlled by this condition.

unitPrice

Money unitPrice

A Contract Valued Item unit valuation measure.

Class org.hl7.fhir.r4.model.Contributor

class Contributor extends Type implements Serializable

serialVersionUID:

-609887113L

Serialized Fields

contact

List<ContactDetail> contact

Contact details to assist a user in finding and communicating with the contributor.

name

StringType name

The name of the individual or organization responsible for the contribution.

type

Enumeration<Contributor.ContributorType> type

The type of contributor.

Class org.hl7.fhir.r4.model.Contributor.ContributorTypeEnumFactory

class ContributorTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Count

class Count extends Quantity implements Serializable

serialVersionUID:

0L

Class org.hl7.fhir.r4.model.Coverage

class Coverage extends DomainResource implements Serializable

serialVersionUID:

212315315L

Serialized Fields

beneficiary

Reference beneficiary

The party who benefits from the insurance coverage; the patient when products and/or services are provided.

beneficiaryTarget

Patient beneficiaryTarget

The actual object that is the target of the reference (The party who benefits from the insurance coverage; the patient when products and/or services are provided.)

class_

List<Coverage.ClassComponent> class_

A suite of underwriter specific classifiers.

contract

List<Reference> contract

The policy(s) which constitute this insurance coverage.

contractTarget

List<Contract> contractTarget

The actual objects that are the target of the reference (The policy(s) which constitute this insurance coverage.)

costToBeneficiary

List<Coverage.CostToBeneficiaryComponent> costToBeneficiary

A suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card.

dependent

StringType dependent

A unique identifier for a dependent under the coverage.

identifier

List<Identifier> identifier

A unique identifier assigned to this coverage.

network

StringType network

The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.

order

PositiveIntType order

The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care.

payor

List<Reference> payor

The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.

payorTarget

List<Resource> payorTarget

The actual objects that are the target of the reference (The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.)

period

Period period

Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.

policyHolder

Reference policyHolder

The party who 'owns' the insurance policy.

policyHolderTarget

Resource policyHolderTarget

The actual object that is the target of the reference (The party who 'owns' the insurance policy.)

relationship

CodeableConcept relationship

The relationship of beneficiary (patient) to the subscriber.

status

Enumeration<Coverage.CoverageStatus> status

The status of the resource instance.

subrogation

BooleanType subrogation

When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.

subscriber

Reference subscriber

The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.

subscriberId

StringType subscriberId

The insurer assigned ID for the Subscriber.

subscriberTarget

Resource subscriberTarget

The actual object that is the target of the reference (The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.)

type

CodeableConcept type

The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.

Class org.hl7.fhir.r4.model.Coverage.ClassComponent

class ClassComponent extends BackboneElement implements Serializable

serialVersionUID:

-1501519769L

Serialized Fields

name

StringType name

A short description for the class.

type

CodeableConcept type

The type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan.

value

StringType value

The alphanumeric string value associated with the insurer issued label.

Class org.hl7.fhir.r4.model.Coverage.CostToBeneficiaryComponent

class CostToBeneficiaryComponent extends BackboneElement implements Serializable

serialVersionUID:

-1302829059L

Serialized Fields

exception

List<Coverage.ExemptionComponent> exception

A suite of codes indicating exceptions or reductions to patient costs and their effective periods.

type

CodeableConcept type

The category of patient centric costs associated with treatment.

value

Type value

The amount due from the patient for the cost category.

Class org.hl7.fhir.r4.model.Coverage.CoverageStatusEnumFactory

class CoverageStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Coverage.ExemptionComponent

class ExemptionComponent extends BackboneElement implements Serializable

serialVersionUID:

523191991L

Serialized Fields

period

Period period

The timeframe during when the exception is in force.

type

CodeableConcept type

The code for the specific exception.

Class org.hl7.fhir.r4.model.CoverageEligibilityRequest

class CoverageEligibilityRequest extends DomainResource implements Serializable

serialVersionUID:

1371127108L

Serialized Fields

created

DateTimeType created

The date when this resource was created.

enterer

Reference enterer

Person who created the request.

entererTarget

Resource entererTarget

The actual object that is the target of the reference (Person who created the request.)

facility

Reference facility

Facility where the services are intended to be provided.

facilityTarget

Location facilityTarget

The actual object that is the target of the reference (Facility where the services are intended to be provided.)

identifier

List<Identifier> identifier

A unique identifier assigned to this coverage eligiblity request.

insurance

List<CoverageEligibilityRequest.InsuranceComponent> insurance

Financial instruments for reimbursement for the health care products and services.

insurer

Reference insurer

The Insurer who issued the coverage in question and is the recipient of the request.

insurerTarget

Organization insurerTarget

The actual object that is the target of the reference (The Insurer who issued the coverage in question and is the recipient of the request.)

item

List<CoverageEligibilityRequest.DetailsComponent> item

Service categories or billable services for which benefit details and/or an authorization prior to service delivery may be required by the payor.

patient

Reference patient

The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.

patientTarget

Patient patientTarget

The actual object that is the target of the reference (The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.)

priority

CodeableConcept priority

When the requestor expects the processor to complete processing.

provider

Reference provider

The provider which is responsible for the request.

providerTarget

Resource providerTarget

The actual object that is the target of the reference (The provider which is responsible for the request.)

purpose

List<Enumeration<CoverageEligibilityRequest.EligibilityRequestPurpose>> purpose

Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.

serviced

Type serviced

The date or dates when the enclosed suite of services were performed or completed.

status

Enumeration<CoverageEligibilityRequest.EligibilityRequestStatus> status

The status of the resource instance.

supportingInfo

List<CoverageEligibilityRequest.SupportingInformationComponent> supportingInfo

Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.

Class org.hl7.fhir.r4.model.CoverageEligibilityRequest.DetailsComponent

class DetailsComponent extends BackboneElement implements Serializable

serialVersionUID:

389110539L

Serialized Fields

category

CodeableConcept category

Code to identify the general type of benefits under which products and services are provided.

detail

List<Reference> detail

The plan/proposal/order describing the proposed service in detail.

detailTarget

List<Resource> detailTarget

The actual objects that are the target of the reference (The plan/proposal/order describing the proposed service in detail.)

diagnosis

List<CoverageEligibilityRequest.DiagnosisComponent> diagnosis

Patient diagnosis for which care is sought.

facility

Reference facility

Facility where the services will be provided.

facilityTarget

Resource facilityTarget

The actual object that is the target of the reference (Facility where the services will be provided.)

modifier

List<CodeableConcept> modifier

Item typification or modifiers codes to convey additional context for the product or service.

productOrService

CodeableConcept productOrService

This contains the product, service, drug or other billing code for the item.

provider

Reference provider

The practitioner who is responsible for the product or service to be rendered to the patient.

providerTarget

Resource providerTarget

The actual object that is the target of the reference (The practitioner who is responsible for the product or service to be rendered to the patient.)

quantity

Quantity quantity

The number of repetitions of a service or product.

supportingInfoSequence

List<PositiveIntType> supportingInfoSequence

Exceptions, special conditions and supporting information applicable for this service or product line.

unitPrice

Money unitPrice

The amount charged to the patient by the provider for a single unit.

Class org.hl7.fhir.r4.model.CoverageEligibilityRequest.DiagnosisComponent

class DiagnosisComponent extends BackboneElement implements Serializable

serialVersionUID:

-454532709L

Serialized Fields

diagnosis

Type diagnosis

The nature of illness or problem in a coded form or as a reference to an external defined Condition.

Class org.hl7.fhir.r4.model.CoverageEligibilityRequest.EligibilityRequestPurposeEnumFactory

class EligibilityRequestPurposeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CoverageEligibilityRequest.EligibilityRequestStatusEnumFactory

class EligibilityRequestStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CoverageEligibilityRequest.InsuranceComponent

class InsuranceComponent extends BackboneElement implements Serializable

serialVersionUID:

692505842L

Serialized Fields

businessArrangement

StringType businessArrangement

A business agreement number established between the provider and the insurer for special business processing purposes.

coverage

Reference coverage

Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.

coverageTarget

Coverage coverageTarget

The actual object that is the target of the reference (Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.)

focal

BooleanType focal

A flag to indicate that this Coverage is to be used for evaluation of this request when set to true.

Class org.hl7.fhir.r4.model.CoverageEligibilityRequest.SupportingInformationComponent

class SupportingInformationComponent extends BackboneElement implements Serializable

serialVersionUID:

819254843L

Serialized Fields

appliesToAll

BooleanType appliesToAll

The supporting materials are applicable for all detail items, product/servce categories and specific billing codes.

information

Reference information

Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

informationTarget

Resource informationTarget

The actual object that is the target of the reference (Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.)

sequence

PositiveIntType sequence

A number to uniquely identify supporting information entries.

Class org.hl7.fhir.r4.model.CoverageEligibilityResponse

class CoverageEligibilityResponse extends DomainResource implements Serializable

serialVersionUID:

-266280848L

Serialized Fields

created

DateTimeType created

The date this resource was created.

disposition

StringType disposition

A human readable description of the status of the adjudication.

error

List<CoverageEligibilityResponse.ErrorsComponent> error

Errors encountered during the processing of the request.

form

CodeableConcept form

A code for the form to be used for printing the content.

identifier

List<Identifier> identifier

A unique identifier assigned to this coverage eligiblity request.

insurance

List<CoverageEligibilityResponse.InsuranceComponent> insurance

Financial instruments for reimbursement for the health care products and services.

insurer

Reference insurer

The Insurer who issued the coverage in question and is the author of the response.

insurerTarget

Organization insurerTarget

The actual object that is the target of the reference (The Insurer who issued the coverage in question and is the author of the response.)

outcome

Enumeration<Enumerations.RemittanceOutcome> outcome

The outcome of the request processing.

patient

Reference patient

The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.

patientTarget

Patient patientTarget

The actual object that is the target of the reference (The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.)

preAuthRef

StringType preAuthRef

A reference from the Insurer to which these services pertain to be used on further communication and as proof that the request occurred.

purpose

List<Enumeration<CoverageEligibilityResponse.EligibilityResponsePurpose>> purpose

Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.

request

Reference request

Reference to the original request resource.

requestor

Reference requestor

The provider which is responsible for the request.

requestorTarget

Resource requestorTarget

The actual object that is the target of the reference (The provider which is responsible for the request.)

requestTarget

CoverageEligibilityRequest requestTarget

The actual object that is the target of the reference (Reference to the original request resource.)

serviced

Type serviced

The date or dates when the enclosed suite of services were performed or completed.

status

Enumeration<CoverageEligibilityResponse.EligibilityResponseStatus> status

The status of the resource instance.

Class org.hl7.fhir.r4.model.CoverageEligibilityResponse.BenefitComponent

class BenefitComponent extends BackboneElement implements Serializable

serialVersionUID:

-1506285314L

Serialized Fields

allowed

Type allowed

The quantity of the benefit which is permitted under the coverage.

type

CodeableConcept type

Classification of benefit being provided.

used

Type used

The quantity of the benefit which have been consumed to date.

Class org.hl7.fhir.r4.model.CoverageEligibilityResponse.EligibilityResponsePurposeEnumFactory

class EligibilityResponsePurposeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CoverageEligibilityResponse.EligibilityResponseStatusEnumFactory

class EligibilityResponseStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.CoverageEligibilityResponse.ErrorsComponent

class ErrorsComponent extends BackboneElement implements Serializable

serialVersionUID:

-1048343046L

Serialized Fields

code

CodeableConcept code

An error code,from a specified code system, which details why the eligibility check could not be performed.

Class org.hl7.fhir.r4.model.CoverageEligibilityResponse.InsuranceComponent

class InsuranceComponent extends BackboneElement implements Serializable

serialVersionUID:

-567336701L

Serialized Fields

benefitPeriod

Period benefitPeriod

The term of the benefits documented in this response.

coverage

Reference coverage

Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.

coverageTarget

Coverage coverageTarget

The actual object that is the target of the reference (Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.)

inforce

BooleanType inforce

Flag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates.

item

List<CoverageEligibilityResponse.ItemsComponent> item

Benefits and optionally current balances, and authorization details by category or service.

Class org.hl7.fhir.r4.model.CoverageEligibilityResponse.ItemsComponent

class ItemsComponent extends BackboneElement implements Serializable

serialVersionUID:

1779114111L

Serialized Fields

authorizationRequired

BooleanType authorizationRequired

A boolean flag indicating whether a preauthorization is required prior to actual service delivery.

authorizationSupporting

List<CodeableConcept> authorizationSupporting

Codes or comments regarding information or actions associated with the preauthorization.

authorizationUrl

UriType authorizationUrl

A web location for obtaining requirements or descriptive information regarding the preauthorization.

benefit

List<CoverageEligibilityResponse.BenefitComponent> benefit

Benefits used to date.

category

CodeableConcept category

Code to identify the general type of benefits under which products and services are provided.

description

StringType description

A richer description of the benefit or services covered.

excluded

BooleanType excluded

True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.

modifier

List<CodeableConcept> modifier

Item typification or modifiers codes to convey additional context for the product or service.

name

StringType name

A short name or tag for the benefit.

network

CodeableConcept network

Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.

productOrService

CodeableConcept productOrService

This contains the product, service, drug or other billing code for the item.

provider

Reference provider

The practitioner who is eligible for the provision of the product or service.

providerTarget

Resource providerTarget

The actual object that is the target of the reference (The practitioner who is eligible for the provision of the product or service.)

term

CodeableConcept term

The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.

unit

CodeableConcept unit

Indicates if the benefits apply to an individual or to the family.

Class org.hl7.fhir.r4.model.DataRequirement

class DataRequirement extends Type implements Serializable

serialVersionUID:

74042278L

Serialized Fields

codeFilter

List<DataRequirement.DataRequirementCodeFilterComponent> codeFilter

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

dateFilter

List<DataRequirement.DataRequirementDateFilterComponent> dateFilter

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

limit

PositiveIntType limit

Specifies a maximum number of results that are required (uses the _count search parameter).

mustSupport

List<StringType> mustSupport

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).

profile

List<CanonicalType> profile

The profile of the required data, specified as the uri of the profile definition.

sort

List<DataRequirement.DataRequirementSortComponent> sort

Specifies the order of the results to be returned.

subject

Type subject

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

type

CodeType type

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

Class org.hl7.fhir.r4.model.DataRequirement.DataRequirementCodeFilterComponent

class DataRequirementCodeFilterComponent extends Element implements Serializable

serialVersionUID:

-1286212752L

Serialized Fields

code

List<Coding> code

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

path

StringType path

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

searchParam

StringType searchParam

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

valueSet

CanonicalType valueSet

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

Class org.hl7.fhir.r4.model.DataRequirement.DataRequirementDateFilterComponent

class DataRequirementDateFilterComponent extends Element implements Serializable

serialVersionUID:

1151620053L

Serialized Fields

path

StringType path

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

searchParam

StringType searchParam

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

value

Type value

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

Class org.hl7.fhir.r4.model.DataRequirement.DataRequirementSortComponent

class DataRequirementSortComponent extends Element implements Serializable

serialVersionUID:

-694498683L

Serialized Fields

direction

Enumeration<DataRequirement.SortDirection> direction

The direction of the sort, ascending or descending.

path

StringType path

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

Class org.hl7.fhir.r4.model.DataRequirement.SortDirectionEnumFactory

class SortDirectionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.DateTimeType

class DateTimeType extends BaseDateTimeType implements Externalizable

serialVersionUID:

3L

Serialization Methods

readExternal

public void readExternal(ObjectInput theIn)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput theOut)
                   throws IOException

Throws:

IOException

Class org.hl7.fhir.r4.model.DateType

class DateType extends BaseDateTimeType implements Externalizable

serialVersionUID:

3L

Serialization Methods

readExternal

public void readExternal(ObjectInput theIn)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput theOut)
                   throws IOException

Throws:

IOException

Class org.hl7.fhir.r4.model.DecimalType

class DecimalType extends PrimitiveType<BigDecimal> implements Externalizable

serialVersionUID:

3L

Serialization Methods

readExternal

public void readExternal(ObjectInput theIn)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput theOut)
                   throws IOException

Throws:

IOException

Class org.hl7.fhir.r4.model.DetectedIssue

class DetectedIssue extends DomainResource implements Serializable

serialVersionUID:

1404426283L

Serialized Fields

author

Reference author

Individual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review.

authorTarget

Resource authorTarget

The actual object that is the target of the reference (Individual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review.)

code

CodeableConcept code

Identifies the general type of issue identified.

detail

StringType detail

A textual explanation of the detected issue.

evidence

List<DetectedIssue.DetectedIssueEvidenceComponent> evidence

Supporting evidence or manifestations that provide the basis for identifying the detected issue such as a GuidanceResponse or MeasureReport.

identified

Type identified

The date or period when the detected issue was initially identified.

identifier

List<Identifier> identifier

Business identifier associated with the detected issue record.

implicated

List<Reference> implicated

Indicates the resource representing the current activity or proposed activity that is potentially problematic.

implicatedTarget

List<Resource> implicatedTarget

The actual objects that are the target of the reference (Indicates the resource representing the current activity or proposed activity that is potentially problematic.)

mitigation

List<DetectedIssue.DetectedIssueMitigationComponent> mitigation

Indicates an action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.

patient

Reference patient

Indicates the patient whose record the detected issue is associated with.

patientTarget

Patient patientTarget

The actual object that is the target of the reference (Indicates the patient whose record the detected issue is associated with.)

reference

UriType reference

The literature, knowledge-base or similar reference that describes the propensity for the detected issue identified.

severity

Enumeration<DetectedIssue.DetectedIssueSeverity> severity

Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.

status

Enumeration<DetectedIssue.DetectedIssueStatus> status

Indicates the status of the detected issue.

Class org.hl7.fhir.r4.model.DetectedIssue.DetectedIssueEvidenceComponent

class DetectedIssueEvidenceComponent extends BackboneElement implements Serializable

serialVersionUID:

1135831276L

Serialized Fields

code

List<CodeableConcept> code

A manifestation that led to the recording of this detected issue.

detail

List<Reference> detail

Links to resources that constitute evidence for the detected issue such as a GuidanceResponse or MeasureReport.

detailTarget

List<Resource> detailTarget

The actual objects that are the target of the reference (Links to resources that constitute evidence for the detected issue such as a GuidanceResponse or MeasureReport.)

Class org.hl7.fhir.r4.model.DetectedIssue.DetectedIssueMitigationComponent

class DetectedIssueMitigationComponent extends BackboneElement implements Serializable

serialVersionUID:

-1928864832L

Serialized Fields

action

CodeableConcept action

Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified issue.

author

Reference author

Identifies the practitioner who determined the mitigation and takes responsibility for the mitigation step occurring.

authorTarget

Resource authorTarget

The actual object that is the target of the reference (Identifies the practitioner who determined the mitigation and takes responsibility for the mitigation step occurring.)

date

DateTimeType date

Indicates when the mitigating action was documented.

Class org.hl7.fhir.r4.model.DetectedIssue.DetectedIssueSeverityEnumFactory

class DetectedIssueSeverityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.DetectedIssue.DetectedIssueStatusEnumFactory

class DetectedIssueStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Device

class Device extends DomainResource implements Serializable

serialVersionUID:

-298380419L

Serialized Fields

contact

List<ContactPoint> contact

Contact details for an organization or a particular human that is responsible for the device.

definition

Reference definition

The reference to the definition for the device.

definitionTarget

DeviceDefinition definitionTarget

The actual object that is the target of the reference (The reference to the definition for the device.)

deviceName

List<Device.DeviceDeviceNameComponent> deviceName

This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.

distinctIdentifier

StringType distinctIdentifier

The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.

expirationDate

DateTimeType expirationDate

The date and time beyond which this device is no longer valid or should not be used (if applicable).

identifier

List<Identifier> identifier

Unique instance identifiers assigned to a device by manufacturers other organizations or owners.

location

Reference location

The place where the device can be found.

locationTarget

Location locationTarget

The actual object that is the target of the reference (The place where the device can be found.)

lotNumber

StringType lotNumber

Lot number assigned by the manufacturer.

manufactureDate

DateTimeType manufactureDate

The date and time when the device was manufactured.

manufacturer

StringType manufacturer

A name of the manufacturer.

modelNumber

StringType modelNumber

The model number for the device.

note

List<Annotation> note

Descriptive information, usage information or implantation information that is not captured in an existing element.

owner

Reference owner

An organization that is responsible for the provision and ongoing maintenance of the device.

ownerTarget

Organization ownerTarget

The actual object that is the target of the reference (An organization that is responsible for the provision and ongoing maintenance of the device.)

parent

Reference parent

The parent device.

parentTarget

Device parentTarget

The actual object that is the target of the reference (The parent device.)

partNumber

StringType partNumber

The part number of the device.

patient

Reference patient

Patient information, If the device is affixed to a person.

patientTarget

Patient patientTarget

The actual object that is the target of the reference (Patient information, If the device is affixed to a person.)

property

List<Device.DevicePropertyComponent> property

The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.

safety

List<CodeableConcept> safety

Provides additional safety characteristics about a medical device. For example devices containing latex.

serialNumber

StringType serialNumber

The serial number assigned by the organization when the device was manufactured.

specialization

List<Device.DeviceSpecializationComponent> specialization

The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.

status

Enumeration<Device.FHIRDeviceStatus> status

Status of the Device availability.

statusReason

List<CodeableConcept> statusReason

Reason for the dtatus of the Device availability.

type

CodeableConcept type

The kind or type of device.

udiCarrier

List<Device.DeviceUdiCarrierComponent> udiCarrier

Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.

url

UriType url

A network address on which the device may be contacted directly.

version

List<Device.DeviceVersionComponent> version

The actual design of the device or software version running on the device.

Class org.hl7.fhir.r4.model.Device.DeviceDeviceNameComponent

class DeviceDeviceNameComponent extends BackboneElement implements Serializable

serialVersionUID:

918983440L

Serialized Fields

name

StringType name

The name of the device.

type

Enumeration<Device.DeviceNameType> type

The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName.

Class org.hl7.fhir.r4.model.Device.DeviceNameTypeEnumFactory

class DeviceNameTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Device.DevicePropertyComponent

class DevicePropertyComponent extends BackboneElement implements Serializable

serialVersionUID:

1512172633L

Serialized Fields

type

CodeableConcept type

Code that specifies the property DeviceDefinitionPropetyCode (Extensible).

valueCode

List<CodeableConcept> valueCode

Property value as a code, e.g., NTP4 (synced to NTP).

valueQuantity

List<Quantity> valueQuantity

Property value as a quantity.

Class org.hl7.fhir.r4.model.Device.DeviceSpecializationComponent

class DeviceSpecializationComponent extends BackboneElement implements Serializable

serialVersionUID:

1557342629L

Serialized Fields

systemType

CodeableConcept systemType

The standard that is used to operate and communicate.

version

StringType version

The version of the standard that is used to operate and communicate.

Class org.hl7.fhir.r4.model.Device.DeviceUdiCarrierComponent

class DeviceUdiCarrierComponent extends BackboneElement implements Serializable

serialVersionUID:

-191630425L

Serialized Fields

carrierAIDC

Base64BinaryType carrierAIDC

The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - e.g., a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats *SHALL* be base64 encoded.

carrierHRF

StringType carrierHRF

The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.

deviceIdentifier

StringType deviceIdentifier

The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.

entryType

Enumeration<Device.UDIEntryType> entryType

A coded entry to indicate how the data was entered.

issuer

UriType issuer

Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include : 1) GS1: http://hl7.org/fhir/NamingSystem/gs1-di, 2) HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-dI, 3) ICCBBA for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood-di, 4) ICCBA for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other-di.

jurisdiction

UriType jurisdiction

The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/fda-udi.

Class org.hl7.fhir.r4.model.Device.DeviceVersionComponent

class DeviceVersionComponent extends BackboneElement implements Serializable

serialVersionUID:

645214295L

Serialized Fields

component

Identifier component

A single component of the device version.

type

CodeableConcept type

The type of the device version.

value

StringType value

The version text.

Class org.hl7.fhir.r4.model.Device.FHIRDeviceStatusEnumFactory

class FHIRDeviceStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Device.UDIEntryTypeEnumFactory

class UDIEntryTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.DeviceDefinition

class DeviceDefinition extends DomainResource implements Serializable

serialVersionUID:

-2041532433L

Serialized Fields

capability

List<DeviceDefinition.DeviceDefinitionCapabilityComponent> capability

Device capabilities.

contact

List<ContactPoint> contact

Contact details for an organization or a particular human that is responsible for the device.

deviceName

List<DeviceDefinition.DeviceDefinitionDeviceNameComponent> deviceName

A name given to the device to identify it.

identifier

List<Identifier> identifier

Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID.

languageCode

List<CodeableConcept> languageCode

Language code for the human-readable text strings produced by the device (all supported).

manufacturer

Type manufacturer

A name of the manufacturer.

material

List<DeviceDefinition.DeviceDefinitionMaterialComponent> material

A substance used to create the material(s) of which the device is made.

modelNumber

StringType modelNumber

The model number for the device.

note

List<Annotation> note

Descriptive information, usage information or implantation information that is not captured in an existing element.

onlineInformation

UriType onlineInformation

Access to on-line information about the device.

owner

Reference owner

An organization that is responsible for the provision and ongoing maintenance of the device.

ownerTarget

Organization ownerTarget

The actual object that is the target of the reference (An organization that is responsible for the provision and ongoing maintenance of the device.)

parentDevice

Reference parentDevice

The parent device it can be part of.

parentDeviceTarget

DeviceDefinition parentDeviceTarget

The actual object that is the target of the reference (The parent device it can be part of.)

physicalCharacteristics

ProdCharacteristic physicalCharacteristics

Dimensions, color etc.

property

List<DeviceDefinition.DeviceDefinitionPropertyComponent> property

The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.

quantity

Quantity quantity

The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product).

safety

List<CodeableConcept> safety

Safety characteristics of the device.

shelfLifeStorage

List<ProductShelfLife> shelfLifeStorage

Shelf Life and storage information.

specialization

List<DeviceDefinition.DeviceDefinitionSpecializationComponent> specialization

The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.

type

CodeableConcept type

What kind of device or device system this is.

udiDeviceIdentifier

List<DeviceDefinition.DeviceDefinitionUdiDeviceIdentifierComponent> udiDeviceIdentifier

Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.

url

UriType url

A network address on which the device may be contacted directly.

version

List<StringType> version

The available versions of the device, e.g., software versions.

Class org.hl7.fhir.r4.model.DeviceDefinition.DeviceDefinitionCapabilityComponent

class DeviceDefinitionCapabilityComponent extends BackboneElement implements Serializable

serialVersionUID:

-192945344L

Serialized Fields

description

List<CodeableConcept> description

Description of capability.

type

CodeableConcept type

Type of capability.

Class org.hl7.fhir.r4.model.DeviceDefinition.DeviceDefinitionDeviceNameComponent

class DeviceDefinitionDeviceNameComponent extends BackboneElement implements Serializable

serialVersionUID:

918983440L

Serialized Fields

name

StringType name

The name of the device.

type

Enumeration<DeviceDefinition.DeviceNameType> type

The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName.

Class org.hl7.fhir.r4.model.DeviceDefinition.DeviceDefinitionMaterialComponent

class DeviceDefinitionMaterialComponent extends BackboneElement implements Serializable

serialVersionUID:

1232736508L

Serialized Fields

allergenicIndicator

BooleanType allergenicIndicator

Whether the substance is a known or suspected allergen.

alternate

BooleanType alternate

Indicates an alternative material of the device.

substance

CodeableConcept substance

The substance.

Class org.hl7.fhir.r4.model.DeviceDefinition.DeviceDefinitionPropertyComponent

class DeviceDefinitionPropertyComponent extends BackboneElement implements Serializable

serialVersionUID:

1512172633L

Serialized Fields

type

CodeableConcept type

Code that specifies the property DeviceDefinitionPropetyCode (Extensible).

valueCode

List<CodeableConcept> valueCode

Property value as a code, e.g., NTP4 (synced to NTP).

valueQuantity

List<Quantity> valueQuantity

Property value as a quantity.

Class org.hl7.fhir.r4.model.DeviceDefinition.DeviceDefinitionSpecializationComponent

class DeviceDefinitionSpecializationComponent extends BackboneElement implements Serializable

serialVersionUID:

-249304393L

Serialized Fields

systemType

StringType systemType

The standard that is used to operate and communicate.

version

StringType version

The version of the standard that is used to operate and communicate.

Class org.hl7.fhir.r4.model.DeviceDefinition.DeviceDefinitionUdiDeviceIdentifierComponent

class DeviceDefinitionUdiDeviceIdentifierComponent extends BackboneElement implements Serializable

serialVersionUID:

-1577319218L

Serialized Fields

deviceIdentifier

StringType deviceIdentifier

The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier.

issuer

UriType issuer

The organization that assigns the identifier algorithm.

jurisdiction

UriType jurisdiction

The jurisdiction to which the deviceIdentifier applies.

Class org.hl7.fhir.r4.model.DeviceDefinition.DeviceNameTypeEnumFactory

class DeviceNameTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.DeviceMetric

class DeviceMetric extends DomainResource implements Serializable

serialVersionUID:

1309955219L

Serialized Fields

calibration

List<DeviceMetric.DeviceMetricCalibrationComponent> calibration

Describes the calibrations that have been performed or that are required to be performed.

category

Enumeration<DeviceMetric.DeviceMetricCategory> category

Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.

color

Enumeration<DeviceMetric.DeviceMetricColor> color

Describes the color representation for the metric. This is often used to aid clinicians to track and identify parameter types by color. In practice, consider a Patient Monitor that has ECG/HR and Pleth for example; the parameters are displayed in different characteristic colors, such as HR-blue, BP-green, and PR and SpO2- magenta.

identifier

List<Identifier> identifier

Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID.

measurementPeriod

Timing measurementPeriod

Describes the measurement repetition time. This is not necessarily the same as the update period. The measurement repetition time can range from milliseconds up to hours. An example for a measurement repetition time in the range of milliseconds is the sampling rate of an ECG. An example for a measurement repetition time in the range of hours is a NIBP that is triggered automatically every hour. The update period may be different than the measurement repetition time, if the device does not update the published observed value with the same frequency as it was measured.

operationalStatus

Enumeration<DeviceMetric.DeviceMetricOperationalStatus> operationalStatus

Indicates current operational state of the device. For example: On, Off, Standby, etc.

parent

Reference parent

Describes the link to the Device that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device. An example would be a Device that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location.

parentTarget

Device parentTarget

The actual object that is the target of the reference (Describes the link to the Device that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device. An example would be a Device that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location.)

source

Reference source

Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.

sourceTarget

Device sourceTarget

The actual object that is the target of the reference (Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.)

type

CodeableConcept type

Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.

unit

CodeableConcept unit

Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.

Class org.hl7.fhir.r4.model.DeviceMetric.DeviceMetricCalibrationComponent

class DeviceMetricCalibrationComponent extends BackboneElement implements Serializable

serialVersionUID:

1163986578L

Serialized Fields

state

Enumeration<DeviceMetric.DeviceMetricCalibrationState> state

Describes the state of the calibration.

time

InstantType time

Describes the time last calibration has been performed.

type

Enumeration<DeviceMetric.DeviceMetricCalibrationType> type

Describes the type of the calibration method.

Class org.hl7.fhir.r4.model.DeviceMetric.DeviceMetricCalibrationStateEnumFactory

class DeviceMetricCalibrationStateEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.DeviceMetric.DeviceMetricCalibrationTypeEnumFactory

class DeviceMetricCalibrationTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.DeviceMetric.DeviceMetricCategoryEnumFactory

class DeviceMetricCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.DeviceMetric.DeviceMetricColorEnumFactory

class DeviceMetricColorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.DeviceMetric.DeviceMetricOperationalStatusEnumFactory

class DeviceMetricOperationalStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.DeviceRequest

class DeviceRequest extends DomainResource implements Serializable

serialVersionUID:

1484452423L

Serialized Fields

authoredOn

DateTimeType authoredOn

When the request transitioned to being actionable.

basedOn

List<Reference> basedOn

Plan/proposal/order fulfilled by this request.

basedOnTarget

List<Resource> basedOnTarget

The actual objects that are the target of the reference (Plan/proposal/order fulfilled by this request.)

code

Type code

The details of the device to be used.

encounter

Reference encounter

An encounter that provides additional context in which this request is made.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (An encounter that provides additional context in which this request is made.)

groupIdentifier

Identifier groupIdentifier

Composite request this is part of.

identifier

List<Identifier> identifier

Identifiers assigned to this order by the orderer or by the receiver.

instantiatesCanonical

List<CanonicalType> instantiatesCanonical

The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.

instantiatesUri

List<UriType> instantiatesUri

The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.

insurance

List<Reference> insurance

Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.

insuranceTarget

List<Resource> insuranceTarget

The actual objects that are the target of the reference (Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.)

intent

Enumeration<DeviceRequest.RequestIntent> intent

Whether the request is a proposal, plan, an original order or a reflex order.

note

List<Annotation> note

Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.

occurrence

Type occurrence

The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".

parameter

List<DeviceRequest.DeviceRequestParameterComponent> parameter

Specific parameters for the ordered item. For example, the prism value for lenses.

performer

Reference performer

The desired performer for doing the diagnostic testing.

performerTarget

Resource performerTarget

The actual object that is the target of the reference (The desired performer for doing the diagnostic testing.)

performerType

CodeableConcept performerType

Desired type of performer for doing the diagnostic testing.

priority

Enumeration<DeviceRequest.RequestPriority> priority

Indicates how quickly the {{title}} should be addressed with respect to other requests.

priorRequest

List<Reference> priorRequest

The request takes the place of the referenced completed or terminated request(s).

priorRequestTarget

List<Resource> priorRequestTarget

The actual objects that are the target of the reference (The request takes the place of the referenced completed or terminated request(s).)

reasonCode

List<CodeableConcept> reasonCode

Reason or justification for the use of this device.

reasonReference

List<Reference> reasonReference

Reason or justification for the use of this device.

reasonReferenceTarget

List<Resource> reasonReferenceTarget

The actual objects that are the target of the reference (Reason or justification for the use of this device.)

relevantHistory

List<Reference> relevantHistory

Key events in the history of the request.

relevantHistoryTarget

List<Provenance> relevantHistoryTarget

The actual objects that are the target of the reference (Key events in the history of the request.)

requester

Reference requester

The individual who initiated the request and has responsibility for its activation.

requesterTarget

Resource requesterTarget

The actual object that is the target of the reference (The individual who initiated the request and has responsibility for its activation.)

status

Enumeration<DeviceRequest.DeviceRequestStatus> status

The status of the request.

subject

Reference subject

The patient who will use the device.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (The patient who will use the device.)

supportingInfo

List<Reference> supportingInfo

Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body the device will be used (i.e. the target site).

supportingInfoTarget

List<Resource> supportingInfoTarget

The actual objects that are the target of the reference (Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body the device will be used (i.e. the target site).)

Class org.hl7.fhir.r4.model.DeviceRequest.DeviceRequestParameterComponent

class DeviceRequestParameterComponent extends BackboneElement implements Serializable

serialVersionUID:

884525025L

Serialized Fields

code

CodeableConcept code

A code or string that identifies the device detail being asserted.

value

Type value

The value of the device detail.

Class org.hl7.fhir.r4.model.DeviceRequest.DeviceRequestStatusEnumFactory

class DeviceRequestStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.DeviceRequest.RequestIntentEnumFactory

class RequestIntentEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.DeviceRequest.RequestPriorityEnumFactory

class RequestPriorityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.DeviceUseStatement

class DeviceUseStatement extends DomainResource implements Serializable

serialVersionUID:

-968330048L

Serialized Fields

basedOn

List<Reference> basedOn

A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement.

basedOnTarget

List<ServiceRequest> basedOnTarget

The actual objects that are the target of the reference (A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement.)

bodySite

CodeableConcept bodySite

Indicates the anotomic location on the subject's body where the device was used ( i.e. the target).

derivedFrom

List<Reference> derivedFrom

Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement.

derivedFromTarget

List<Resource> derivedFromTarget

The actual objects that are the target of the reference (Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement.)

device

Reference device

The details of the device used.

deviceTarget

Device deviceTarget

The actual object that is the target of the reference (The details of the device used.)

identifier

List<Identifier> identifier

An external identifier for this statement such as an IRI.

note

List<Annotation> note

Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.

reasonCode

List<CodeableConcept> reasonCode

Reason or justification for the use of the device.

reasonReference

List<Reference> reasonReference

Indicates another resource whose existence justifies this DeviceUseStatement.

reasonReferenceTarget

List<Resource> reasonReferenceTarget

The actual objects that are the target of the reference (Indicates another resource whose existence justifies this DeviceUseStatement.)

recordedOn

DateTimeType recordedOn

The time at which the statement was made/recorded.

source

Reference source

Who reported the device was being used by the patient.

sourceTarget

Resource sourceTarget

The actual object that is the target of the reference (Who reported the device was being used by the patient.)

status

Enumeration<DeviceUseStatement.DeviceUseStatementStatus> status

A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed.

subject

Reference subject

The patient who used the device.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (The patient who used the device.)

timing

Type timing

How often the device was used.

Class org.hl7.fhir.r4.model.DeviceUseStatement.DeviceUseStatementStatusEnumFactory

class DeviceUseStatementStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.DiagnosticReport

class DiagnosticReport extends DomainResource implements Serializable

serialVersionUID:

589102296L

Serialized Fields

basedOn

List<Reference> basedOn

Details concerning a service requested.

basedOnTarget

List<Resource> basedOnTarget

The actual objects that are the target of the reference (Details concerning a service requested.)

category

List<CodeableConcept> category

A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.

code

CodeableConcept code

A code or name that describes this diagnostic report.

conclusion

StringType conclusion

Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.

conclusionCode

List<CodeableConcept> conclusionCode

One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.

effective

Type effective

The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.

encounter

Reference encounter

The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.)

identifier

List<Identifier> identifier

Identifiers assigned to this report by the performer or other systems.

imagingStudy

List<Reference> imagingStudy

One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.

imagingStudyTarget

List<ImagingStudy> imagingStudyTarget

The actual objects that are the target of the reference (One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.)

issued

InstantType issued

The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified.

media

List<DiagnosticReport.DiagnosticReportMediaComponent> media

A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).

performer

List<Reference> performer

The diagnostic service that is responsible for issuing the report.

performerTarget

List<Resource> performerTarget

The actual objects that are the target of the reference (The diagnostic service that is responsible for issuing the report.)

presentedForm

List<Attachment> presentedForm

Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.

result

List<Reference> result

[Observations](observation.html) that are part of this diagnostic report.

resultsInterpreter

List<Reference> resultsInterpreter

The practitioner or organization that is responsible for the report's conclusions and interpretations.

resultsInterpreterTarget

List<Resource> resultsInterpreterTarget

The actual objects that are the target of the reference (The practitioner or organization that is responsible for the report's conclusions and interpretations.)

resultTarget

List<Observation> resultTarget

The actual objects that are the target of the reference ([Observations](observation.html) that are part of this diagnostic report.)

specimen

List<Reference> specimen

Details about the specimens on which this diagnostic report is based.

specimenTarget

List<Specimen> specimenTarget

The actual objects that are the target of the reference (Details about the specimens on which this diagnostic report is based.)

status

Enumeration<DiagnosticReport.DiagnosticReportStatus> status

The status of the diagnostic report.

subject

Reference subject

The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.)

Class org.hl7.fhir.r4.model.DiagnosticReport.DiagnosticReportMediaComponent

class DiagnosticReportMediaComponent extends BackboneElement implements Serializable

serialVersionUID:

935791940L

Serialized Fields

comment

StringType comment

A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features.

link

Reference link

Reference to the image source.

linkTarget

Media linkTarget

The actual object that is the target of the reference (Reference to the image source.)

Class org.hl7.fhir.r4.model.DiagnosticReport.DiagnosticReportStatusEnumFactory

class DiagnosticReportStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Distance

class Distance extends Quantity implements Serializable

serialVersionUID:

0L

Class org.hl7.fhir.r4.model.DocumentManifest

class DocumentManifest extends DomainResource implements Serializable

serialVersionUID:

432971934L

Serialized Fields

author

List<Reference> author

Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.

authorTarget

List<Resource> authorTarget

The actual objects that are the target of the reference (Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.)

content

List<Reference> content

The list of Resources that consist of the parts of this manifest.

contentTarget

List<Resource> contentTarget

The actual objects that are the target of the reference (The list of Resources that consist of the parts of this manifest.)

created

DateTimeType created

When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.).

description

StringType description

Human-readable description of the source document. This is sometimes known as the "title".

identifier

List<Identifier> identifier

Other identifiers associated with the document manifest, including version independent identifiers.

masterIdentifier

Identifier masterIdentifier

A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.

recipient

List<Reference> recipient

A patient, practitioner, or organization for which this set of documents is intended.

recipientTarget

List<Resource> recipientTarget

The actual objects that are the target of the reference (A patient, practitioner, or organization for which this set of documents is intended.)

related

List<DocumentManifest.DocumentManifestRelatedComponent> related

Related identifiers or resources associated with the DocumentManifest.

source

UriType source

Identifies the source system, application, or software that produced the document manifest.

status

Enumeration<Enumerations.DocumentReferenceStatus> status

The status of this document manifest.

subject

Reference subject

Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).)

type

CodeableConcept type

The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.

Class org.hl7.fhir.r4.model.DocumentManifest.DocumentManifestRelatedComponent

class DocumentManifestRelatedComponent extends BackboneElement implements Serializable

serialVersionUID:

-1670123330L

Serialized Fields

identifier

Identifier identifier

Related identifier to this DocumentManifest. For example, Order numbers, accession numbers, XDW workflow numbers.

ref

Reference ref

Related Resource to this DocumentManifest. For example, Order, ServiceRequest, Procedure, EligibilityRequest, etc.

refTarget

Resource refTarget

The actual object that is the target of the reference (Related Resource to this DocumentManifest. For example, Order, ServiceRequest, Procedure, EligibilityRequest, etc.)

Class org.hl7.fhir.r4.model.DocumentReference

class DocumentReference extends DomainResource implements Serializable

serialVersionUID:

307086535L

Serialized Fields

authenticator

Reference authenticator

Which person or organization authenticates that this document is valid.

authenticatorTarget

Resource authenticatorTarget

The actual object that is the target of the reference (Which person or organization authenticates that this document is valid.)

author

List<Reference> author

Identifies who is responsible for adding the information to the document.

authorTarget

List<Resource> authorTarget

The actual objects that are the target of the reference (Identifies who is responsible for adding the information to the document.)

category

List<CodeableConcept> category

A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.

content

List<DocumentReference.DocumentReferenceContentComponent> content

The document and format referenced. There may be multiple content element repetitions, each with a different format.

context

DocumentReference.DocumentReferenceContextComponent context

The clinical context in which the document was prepared.

custodian

Reference custodian

Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.

custodianTarget

Organization custodianTarget

The actual object that is the target of the reference (Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.)

date

InstantType date

When the document reference was created.

description

StringType description

Human-readable description of the source document.

docStatus

Enumeration<DocumentReference.ReferredDocumentStatus> docStatus

The status of the underlying document.

identifier

List<Identifier> identifier

Other identifiers associated with the document, including version independent identifiers.

masterIdentifier

Identifier masterIdentifier

Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.

relatesTo

List<DocumentReference.DocumentReferenceRelatesToComponent> relatesTo

Relationships that this document has with other document references that already exist.

securityLabel

List<CodeableConcept> securityLabel

A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.

status

Enumeration<Enumerations.DocumentReferenceStatus> status

The status of this document reference.

subject

Reference subject

Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).)

type

CodeableConcept type

Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.

Class org.hl7.fhir.r4.model.DocumentReference.DocumentReferenceContentComponent

class DocumentReferenceContentComponent extends BackboneElement implements Serializable

serialVersionUID:

-1313860217L

Serialized Fields

attachment

Attachment attachment

The document or URL of the document along with critical metadata to prove content has integrity.

format

Coding format

An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.

Class org.hl7.fhir.r4.model.DocumentReference.DocumentReferenceContextComponent

class DocumentReferenceContextComponent extends BackboneElement implements Serializable

serialVersionUID:

140463218L

Serialized Fields

encounter

List<Reference> encounter

Describes the clinical encounter or type of care that the document content is associated with.

encounterTarget

List<Resource> encounterTarget

The actual objects that are the target of the reference (Describes the clinical encounter or type of care that the document content is associated with.)

event

List<CodeableConcept> event

This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.

facilityType

CodeableConcept facilityType

The kind of facility where the patient was seen.

period

Period period

The time period over which the service that is described by the document was provided.

practiceSetting

CodeableConcept practiceSetting

This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.

related

List<Reference> related

Related identifiers or resources associated with the DocumentReference.

relatedTarget

List<Resource> relatedTarget

The actual objects that are the target of the reference (Related identifiers or resources associated with the DocumentReference.)

sourcePatientInfo

Reference sourcePatientInfo

The Patient Information as known when the document was published. May be a reference to a version specific, or contained.

sourcePatientInfoTarget

Patient sourcePatientInfoTarget

The actual object that is the target of the reference (The Patient Information as known when the document was published. May be a reference to a version specific, or contained.)

Class org.hl7.fhir.r4.model.DocumentReference.DocumentReferenceRelatesToComponent

class DocumentReferenceRelatesToComponent extends BackboneElement implements Serializable

serialVersionUID:

-347257495L

Serialized Fields

code

Enumeration<DocumentReference.DocumentRelationshipType> code

The type of relationship that this document has with anther document.

target

Reference target

The target document of this relationship.

targetTarget

DocumentReference targetTarget

The actual object that is the target of the reference (The target document of this relationship.)

Class org.hl7.fhir.r4.model.DocumentReference.DocumentRelationshipTypeEnumFactory

class DocumentRelationshipTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.DocumentReference.ReferredDocumentStatusEnumFactory

class ReferredDocumentStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.DomainResource

class DomainResource extends Resource implements Serializable

serialVersionUID:

-970285559L

Serialized Fields

contained

List<Resource> contained

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

extension

List<Extension> extension

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

modifierExtension

List<Extension> modifierExtension

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

text

Narrative text

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Class org.hl7.fhir.r4.model.Dosage

class Dosage extends BackboneType implements Serializable

serialVersionUID:

-1095063329L

Serialized Fields

additionalInstruction

List<CodeableConcept> additionalInstruction

Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").

asNeeded

Type asNeeded

Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).

doseAndRate

List<Dosage.DosageDoseAndRateComponent> doseAndRate

The amount of medication administered.

maxDosePerAdministration

Quantity maxDosePerAdministration

Upper limit on medication per administration.

maxDosePerLifetime

Quantity maxDosePerLifetime

Upper limit on medication per lifetime of the patient.

maxDosePerPeriod

Ratio maxDosePerPeriod

Upper limit on medication per unit of time.

method

CodeableConcept method

Technique for administering medication.

patientInstruction

StringType patientInstruction

Instructions in terms that are understood by the patient or consumer.

route

CodeableConcept route

How drug should enter body.

sequence

IntegerType sequence

Indicates the order in which the dosage instructions should be applied or interpreted.

site

CodeableConcept site

Body site to administer to.

text

StringType text

Free text dosage instructions e.g. SIG.

timing

Timing timing

When medication should be administered.

Class org.hl7.fhir.r4.model.Dosage.DosageDoseAndRateComponent

class DosageDoseAndRateComponent extends Element implements Serializable

serialVersionUID:

-2133698888L

Serialized Fields

dose

Type dose

Amount of medication per dose.

rate

Type rate

Amount of medication per unit of time.

type

CodeableConcept type

The kind of dose or rate specified, for example, ordered or calculated.

Class org.hl7.fhir.r4.model.Duration

class Duration extends Quantity implements Serializable

serialVersionUID:

0L

Class org.hl7.fhir.r4.model.EffectEvidenceSynthesis

class EffectEvidenceSynthesis extends MetadataResource implements Serializable

serialVersionUID:

23150467L

Serialized Fields

approvalDate

DateType approvalDate

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

author

List<ContactDetail> author

An individiual or organization primarily involved in the creation and maintenance of the content.

certainty

List<EffectEvidenceSynthesis.EffectEvidenceSynthesisCertaintyComponent> certainty

A description of the certainty of the effect estimate.

copyright

MarkdownType copyright

A copyright statement relating to the effect evidence synthesis and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the effect evidence synthesis.

editor

List<ContactDetail> editor

An individual or organization primarily responsible for internal coherence of the content.

effectEstimate

List<EffectEvidenceSynthesis.EffectEvidenceSynthesisEffectEstimateComponent> effectEstimate

The estimated effect of the exposure variant.

effectivePeriod

Period effectivePeriod

The period during which the effect evidence synthesis content was or is planned to be in active use.

endorser

List<ContactDetail> endorser

An individual or organization responsible for officially endorsing the content for use in some setting.

exposure

Reference exposure

A reference to a EvidenceVariable resource that defines the exposure for the research.

exposureAlternative

Reference exposureAlternative

A reference to a EvidenceVariable resource that defines the comparison exposure for the research.

exposureAlternativeTarget

EvidenceVariable exposureAlternativeTarget

The actual object that is the target of the reference (A reference to a EvidenceVariable resource that defines the comparison exposure for the research.)

exposureTarget

EvidenceVariable exposureTarget

The actual object that is the target of the reference (A reference to a EvidenceVariable resource that defines the exposure for the research.)

identifier

List<Identifier> identifier

A formal identifier that is used to identify this effect evidence synthesis when it is represented in other formats, or referenced in a specification, model, design or an instance.

lastReviewDate

DateType lastReviewDate

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

note

List<Annotation> note

A human-readable string to clarify or explain concepts about the resource.

outcome

Reference outcome

A reference to a EvidenceVariable resomece that defines the outcome for the research.

outcomeTarget

EvidenceVariable outcomeTarget

The actual object that is the target of the reference (A reference to a EvidenceVariable resomece that defines the outcome for the research.)

population

Reference population

A reference to a EvidenceVariable resource that defines the population for the research.

populationTarget

EvidenceVariable populationTarget

The actual object that is the target of the reference (A reference to a EvidenceVariable resource that defines the population for the research.)

relatedArtifact

List<RelatedArtifact> relatedArtifact

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

resultsByExposure

List<EffectEvidenceSynthesis.EffectEvidenceSynthesisResultsByExposureComponent> resultsByExposure

A description of the results for each exposure considered in the effect estimate.

reviewer

List<ContactDetail> reviewer

An individual or organization primarily responsible for review of some aspect of the content.

sampleSize

EffectEvidenceSynthesis.EffectEvidenceSynthesisSampleSizeComponent sampleSize

A description of the size of the sample involved in the synthesis.

studyType

CodeableConcept studyType

Type of study eg randomized trial.

synthesisType

CodeableConcept synthesisType

Type of synthesis eg meta-analysis.

topic

List<CodeableConcept> topic

Descriptive topics related to the content of the EffectEvidenceSynthesis. Topics provide a high-level categorization grouping types of EffectEvidenceSynthesiss that can be useful for filtering and searching.

Class org.hl7.fhir.r4.model.EffectEvidenceSynthesis.EffectEvidenceSynthesisCertaintyCertaintySubcomponentComponent

class EffectEvidenceSynthesisCertaintyCertaintySubcomponentComponent extends BackboneElement implements Serializable

serialVersionUID:

-411994816L

Serialized Fields

note

List<Annotation> note

A human-readable string to clarify or explain concepts about the resource.

rating

List<CodeableConcept> rating

A rating of a subcomponent of rating certainty.

type

CodeableConcept type

Type of subcomponent of certainty rating.

Class org.hl7.fhir.r4.model.EffectEvidenceSynthesis.EffectEvidenceSynthesisCertaintyComponent

class EffectEvidenceSynthesisCertaintyComponent extends BackboneElement implements Serializable

serialVersionUID:

647101417L

Serialized Fields

certaintySubcomponent

List<EffectEvidenceSynthesis.EffectEvidenceSynthesisCertaintyCertaintySubcomponentComponent> certaintySubcomponent

A description of a component of the overall certainty.

note

List<Annotation> note

A human-readable string to clarify or explain concepts about the resource.

rating

List<CodeableConcept> rating

A rating of the certainty of the effect estimate.

Class org.hl7.fhir.r4.model.EffectEvidenceSynthesis.EffectEvidenceSynthesisEffectEstimateComponent

class EffectEvidenceSynthesisEffectEstimateComponent extends BackboneElement implements Serializable

serialVersionUID:

-1075065083L

Serialized Fields

description

StringType description

Human-readable summary of effect estimate.

precisionEstimate

List<EffectEvidenceSynthesis.EffectEvidenceSynthesisEffectEstimatePrecisionEstimateComponent> precisionEstimate

A description of the precision of the estimate for the effect.

type

CodeableConcept type

Examples include relative risk and mean difference.

unitOfMeasure

CodeableConcept unitOfMeasure

Specifies the UCUM unit for the outcome.

value

DecimalType value

The point estimate of the effect estimate.

variantState

CodeableConcept variantState

Used to define variant exposure states such as low-risk state.

Class org.hl7.fhir.r4.model.EffectEvidenceSynthesis.EffectEvidenceSynthesisEffectEstimatePrecisionEstimateComponent

class EffectEvidenceSynthesisEffectEstimatePrecisionEstimateComponent extends BackboneElement implements Serializable

serialVersionUID:

-110178057L

Serialized Fields

from

DecimalType from

Lower bound of confidence interval.

level

DecimalType level

Use 95 for a 95% confidence interval.

to

DecimalType to

Upper bound of confidence interval.

type

CodeableConcept type

Examples include confidence interval and interquartile range.

Class org.hl7.fhir.r4.model.EffectEvidenceSynthesis.EffectEvidenceSynthesisResultsByExposureComponent

class EffectEvidenceSynthesisResultsByExposureComponent extends BackboneElement implements Serializable

serialVersionUID:

144886133L

Serialized Fields

description

StringType description

Human-readable summary of results by exposure state.

exposureState

Enumeration<EffectEvidenceSynthesis.ExposureState> exposureState

Whether these results are for the exposure state or alternative exposure state.

riskEvidenceSynthesis

Reference riskEvidenceSynthesis

Reference to a RiskEvidenceSynthesis resource.

riskEvidenceSynthesisTarget

RiskEvidenceSynthesis riskEvidenceSynthesisTarget

The actual object that is the target of the reference (Reference to a RiskEvidenceSynthesis resource.)

variantState

CodeableConcept variantState

Used to define variant exposure states such as low-risk state.

Class org.hl7.fhir.r4.model.EffectEvidenceSynthesis.EffectEvidenceSynthesisSampleSizeComponent

class EffectEvidenceSynthesisSampleSizeComponent extends BackboneElement implements Serializable

serialVersionUID:

-1116074476L

Serialized Fields

description

StringType description

Human-readable summary of sample size.

numberOfParticipants

IntegerType numberOfParticipants

Number of participants included in this evidence synthesis.

numberOfStudies

IntegerType numberOfStudies

Number of studies included in this evidence synthesis.

Class org.hl7.fhir.r4.model.EffectEvidenceSynthesis.ExposureStateEnumFactory

class ExposureStateEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Element

class Element extends Base implements Serializable

serialVersionUID:

-1452745816L

Serialized Fields

disallowExtensions

boolean disallowExtensions

This is used in the FHIRPath engine to record that no extensions are allowed for this item in the context in which it is used. todo: enforce this....

extension

List<Extension> extension

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

id

StringType id

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Class org.hl7.fhir.r4.model.ElementDefinition

class ElementDefinition extends BackboneType implements Serializable

serialVersionUID:

1482114790L

Serialized Fields

alias

List<StringType> alias

Identifies additional names by which this element might also be known.

base

ElementDefinition.ElementDefinitionBaseComponent base

Information about the base definition of the element, provided to make it unnecessary for tools to trace the deviation of the element through the derived and related profiles. When the element definition is not the original definition of an element - i.g. either in a constraint on another type, or for elements from a super type in a snap shot - then the information in provided in the element definition may be different to the base definition. On the original definition of the element, it will be same.

binding

ElementDefinition.ElementDefinitionBindingComponent binding

Binds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri).

code

List<Coding> code

A code that has the same meaning as the element in a particular terminology.

comment

MarkdownType comment

Explanatory notes and implementation guidance about the data element, including notes about how to use the data properly, exceptions to proper use, etc. (Note: The text you are reading is specified in ElementDefinition.comment).

condition

List<IdType> condition

A reference to an invariant that may make additional statements about the cardinality or value in the instance.

constraint

List<ElementDefinition.ElementDefinitionConstraintComponent> constraint

Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.

contentReference

UriType contentReference

Identifies an element defined elsewhere in the definition whose content rules should be applied to the current element. ContentReferences bring across all the rules that are in the ElementDefinition for the element, including definitions, cardinality constraints, bindings, invariants etc.

defaultValue

Type defaultValue

The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').

definition

MarkdownType definition

Provides a complete explanation of the meaning of the data element for human readability. For the case of elements derived from existing elements (e.g. constraints), the definition SHALL be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resource. (Note: The text you are reading is specified in ElementDefinition.definition).

example

List<ElementDefinition.ElementDefinitionExampleComponent> example

A sample value for this element demonstrating the type of information that would typically be found in the element.

fixed

Type fixed

Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.

isModifier

BooleanType isModifier

If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they SHALL either recognize the element and process it, and/or a pre-determination has been made that it is not relevant to their particular system.

isModifierReason

StringType isModifierReason

Explains how that element affects the interpretation of the resource or element that contains it.

isSummary

BooleanType isSummary

Whether the element should be included if a client requests a search with the parameter _summary=true.

label

StringType label

A single preferred label which is the text to display beside the element indicating its meaning or to use to prompt for the element in a user display or form.

mapping

List<ElementDefinition.ElementDefinitionMappingComponent> mapping

Identifies a concept from an external specification that roughly corresponds to this element.

max

StringType max

The maximum number of times this element is permitted to appear in the instance.

maxLength

IntegerType maxLength

Indicates the maximum length in characters that is permitted to be present in conformant instances and which is expected to be supported by conformant consumers that support the element.

maxValue

Type maxValue

The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.

meaningWhenMissing

MarkdownType meaningWhenMissing

The Implicit meaning that is to be understood when this element is missing (e.g. 'when this element is missing, the period is ongoing').

min

UnsignedIntType min

The minimum number of times this element SHALL appear in the instance.

minValue

Type minValue

The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.

mustSupport

BooleanType mustSupport

If true, implementations that produce or consume resources SHALL provide "support" for the element in some meaningful way. If false, the element may be ignored and not supported. If false, whether to populate or use the data element in any way is at the discretion of the implementation.

orderMeaning

StringType orderMeaning

If present, indicates that the order of the repeating element has meaning and describes what that meaning is. If absent, it means that the order of the element has no meaning.

path

StringType path

The path identifies the element and is expressed as a "."-separated list of ancestor elements, beginning with the name of the resource or extension.

pattern

Type pattern

Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value.

representation

List<Enumeration<ElementDefinition.PropertyRepresentation>> representation

Codes that define how this element is represented in instances, when the deviation varies from the normal case.

requirements

MarkdownType requirements

This element is for traceability of why the element was created and why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this element.

short_

StringType short_

A concise description of what this element means (e.g. for use in autogenerated summaries).

sliceIsConstraining

BooleanType sliceIsConstraining

If true, indicates that this slice definition is constraining a slice definition with the same name in an inherited profile. If false, the slice is not overriding any slice in an inherited profile. If missing, the slice might or might not be overriding a slice in an inherited profile, depending on the sliceName.

sliceName

StringType sliceName

The name of this element definition slice, when slicing is working. The name must be a token with no dots or spaces. This is a unique name referring to a specific set of constraints applied to this element, used to provide a name to different slices of the same element.

slicing

ElementDefinition.ElementDefinitionSlicingComponent slicing

Indicates that the element is sliced into a set of alternative definitions (i.e. in a structure definition, there are multiple different constraints on a single element in the base resource). Slicing can be used in any resource that has cardinality ..* on the base resource, or any resource with a choice of types. The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set).

type

List<ElementDefinition.TypeRefComponent> type

The data type or resource that the value of this element is permitted to be.

Class org.hl7.fhir.r4.model.ElementDefinition.AggregationModeEnumFactory

class AggregationModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ElementDefinition.ConstraintSeverityEnumFactory

class ConstraintSeverityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ElementDefinition.DiscriminatorTypeEnumFactory

class DiscriminatorTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ElementDefinition.ElementDefinitionBaseComponent

class ElementDefinitionBaseComponent extends Element implements Serializable

serialVersionUID:

-1412704221L

Serialized Fields

max

StringType max

Maximum cardinality of the base element identified by the path.

min

UnsignedIntType min

Minimum cardinality of the base element identified by the path.

path

StringType path

The Path that identifies the base element - this matches the ElementDefinition.path for that element. Across FHIR, there is only one base definition of any element - that is, an element definition on a [[[StructureDefinition]]] without a StructureDefinition.base.

Class org.hl7.fhir.r4.model.ElementDefinition.ElementDefinitionBindingComponent

class ElementDefinitionBindingComponent extends Element implements Serializable

serialVersionUID:

-514477030L

Serialized Fields

description

StringType description

Describes the intended use of this particular set of codes.

strength

Enumeration<Enumerations.BindingStrength> strength

Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.

valueSet

CanonicalType valueSet

Refers to the value set that identifies the set of codes the binding refers to.

Class org.hl7.fhir.r4.model.ElementDefinition.ElementDefinitionConstraintComponent

class ElementDefinitionConstraintComponent extends Element implements Serializable

serialVersionUID:

1048354565L

Serialized Fields

expression

StringType expression

A [FHIRPath](fhirpath.html) expression of constraint that can be executed to see if this constraint is met.

human

StringType human

Text that can be used to describe the constraint in messages identifying that the constraint has been violated.

key

IdType key

Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.

requirements

StringType requirements

Description of why this constraint is necessary or appropriate.

severity

Enumeration<ElementDefinition.ConstraintSeverity> severity

Identifies the impact constraint violation has on the conformance of the instance.

source

CanonicalType source

A reference to the original source of the constraint, for traceability purposes.

xpath

StringType xpath

An XPath expression of constraint that can be executed to see if this constraint is met.

Class org.hl7.fhir.r4.model.ElementDefinition.ElementDefinitionExampleComponent

class ElementDefinitionExampleComponent extends Element implements Serializable

serialVersionUID:

457572481L

Serialized Fields

label

StringType label

Describes the purpose of this example amoung the set of examples.

value

Type value

The actual value for the element, which must be one of the types allowed for this element.

Class org.hl7.fhir.r4.model.ElementDefinition.ElementDefinitionMappingComponent

class ElementDefinitionMappingComponent extends Element implements Serializable

serialVersionUID:

1386816887L

Serialized Fields

comment

StringType comment

Comments that provide information about the mapping or its use.

identity

IdType identity

An internal reference to the definition of a mapping.

language

CodeType language

Identifies the computable language in which mapping.map is expressed.

map

StringType map

Expresses what part of the target specification corresponds to this element.

Class org.hl7.fhir.r4.model.ElementDefinition.ElementDefinitionSlicingComponent

class ElementDefinitionSlicingComponent extends Element implements Serializable

serialVersionUID:

-311635839L

Serialized Fields

description

StringType description

A human-readable text description of how the slicing works. If there is no discriminator, this is required to be present to provide whatever information is possible about how the slices can be differentiated.

discriminator

List<ElementDefinition.ElementDefinitionSlicingDiscriminatorComponent> discriminator

Designates which child elements are used to discriminate between the slices when processing an instance. If one or more discriminators are provided, the value of the child elements in the instance data SHALL completely distinguish which slice the element in the resource matches based on the allowed values for those elements in each of the slices.

ordered

BooleanType ordered

If the matching elements have to occur in the same order as defined in the profile.

rules

Enumeration<ElementDefinition.SlicingRules> rules

Whether additional slices are allowed or not. When the slices are ordered, profile authors can also say that additional slices are only allowed at the end.

Class org.hl7.fhir.r4.model.ElementDefinition.ElementDefinitionSlicingDiscriminatorComponent

class ElementDefinitionSlicingDiscriminatorComponent extends Element implements Serializable

serialVersionUID:

1151159293L

Serialized Fields

path

StringType path

A FHIRPath expression, using [the simple subset of FHIRPath](fhirpath.html#simple), that is used to identify the element on which discrimination is based.

type

Enumeration<ElementDefinition.DiscriminatorType> type

How the element value is interpreted when discrimination is evaluated.

Class org.hl7.fhir.r4.model.ElementDefinition.PropertyRepresentationEnumFactory

class PropertyRepresentationEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ElementDefinition.ReferenceVersionRulesEnumFactory

class ReferenceVersionRulesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ElementDefinition.SlicingRulesEnumFactory

class SlicingRulesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ElementDefinition.TypeRefComponent

class TypeRefComponent extends Element implements Serializable

serialVersionUID:

957891653L

Serialized Fields

aggregation

List<Enumeration<ElementDefinition.AggregationMode>> aggregation

If the type is a reference to another resource, how the resource is or can be aggregated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.

code

UriType code

URL of Data type or Resource that is a(or the) type used for this element. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. "string" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.

profile

List<CanonicalType> profile

Identifies a profile structure or implementation Guide that applies to the datatype this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the type SHALL conform to at least one profile defined in the implementation guide.

targetProfile

List<CanonicalType> targetProfile

Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.

versioning

Enumeration<ElementDefinition.ReferenceVersionRules> versioning

Whether this reference needs to be version specific or version independent, or whether either can be used.

Class org.hl7.fhir.r4.model.Encounter

class Encounter extends DomainResource implements Serializable

serialVersionUID:

1358318037L

Serialized Fields

account

List<Reference> account

The set of accounts that may be used for billing for this Encounter.

accountTarget

List<Account> accountTarget

The actual objects that are the target of the reference (The set of accounts that may be used for billing for this Encounter.)

appointment

List<Reference> appointment

The appointment that scheduled this encounter.

appointmentTarget

List<Appointment> appointmentTarget

The actual objects that are the target of the reference (The appointment that scheduled this encounter.)

basedOn

List<Reference> basedOn

The request this encounter satisfies (e.g. incoming referral or procedure request).

basedOnTarget

List<ServiceRequest> basedOnTarget

The actual objects that are the target of the reference (The request this encounter satisfies (e.g. incoming referral or procedure request).)

class_

Coding class_

Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.

classHistory

List<Encounter.ClassHistoryComponent> classHistory

The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.

diagnosis

List<Encounter.DiagnosisComponent> diagnosis

The list of diagnosis relevant to this encounter.

episodeOfCare

List<Reference> episodeOfCare

Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).

episodeOfCareTarget

List<EpisodeOfCare> episodeOfCareTarget

The actual objects that are the target of the reference (Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).)

hospitalization

Encounter.EncounterHospitalizationComponent hospitalization

Details about the admission to a healthcare service.

identifier

List<Identifier> identifier

Identifier(s) by which this encounter is known.

length

Duration length

Quantity of time the encounter lasted. This excludes the time during leaves of absence.

location

List<Encounter.EncounterLocationComponent> location

List of locations where the patient has been during this encounter.

participant

List<Encounter.EncounterParticipantComponent> participant

The list of people responsible for providing the service.

partOf

Reference partOf

Another Encounter of which this encounter is a part of (administratively or in time).

partOfTarget

Encounter partOfTarget

The actual object that is the target of the reference (Another Encounter of which this encounter is a part of (administratively or in time).)

period

Period period

The start and end time of the encounter.

priority

CodeableConcept priority

Indicates the urgency of the encounter.

reasonCode

List<CodeableConcept> reasonCode

Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.

reasonReference

List<Reference> reasonReference

Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.

reasonReferenceTarget

List<Resource> reasonReferenceTarget

The actual objects that are the target of the reference (Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.)

serviceProvider

Reference serviceProvider

The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.

serviceProviderTarget

Organization serviceProviderTarget

The actual object that is the target of the reference (The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.)

serviceType

CodeableConcept serviceType

Broad categorization of the service that is to be provided (e.g. cardiology).

status

Enumeration<Encounter.EncounterStatus> status

planned | arrived | triaged | in-progress | onleave | finished | cancelled +.

statusHistory

List<Encounter.StatusHistoryComponent> statusHistory

The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.

subject

Reference subject

The patient or group present at the encounter.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (The patient or group present at the encounter.)

type

List<CodeableConcept> type

Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).

Class org.hl7.fhir.r4.model.Encounter.ClassHistoryComponent

class ClassHistoryComponent extends BackboneElement implements Serializable

serialVersionUID:

1331020311L

Serialized Fields

class_

Coding class_

inpatient | outpatient | ambulatory | emergency +.

period

Period period

The time that the episode was in the specified class.

Class org.hl7.fhir.r4.model.Encounter.DiagnosisComponent

class DiagnosisComponent extends BackboneElement implements Serializable

serialVersionUID:

128213376L

Serialized Fields

condition

Reference condition

Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.

conditionTarget

Resource conditionTarget

The actual object that is the target of the reference (Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.)

rank

PositiveIntType rank

Ranking of the diagnosis (for each role type).

use

CodeableConcept use

Role that this diagnosis has within the encounter (e.g. admission, billing, discharge ?).

Class org.hl7.fhir.r4.model.Encounter.EncounterHospitalizationComponent

class EncounterHospitalizationComponent extends BackboneElement implements Serializable

serialVersionUID:

1350555270L

Serialized Fields

admitSource

CodeableConcept admitSource

From where patient was admitted (physician referral, transfer).

destination

Reference destination

Location/organization to which the patient is discharged.

destinationTarget

Resource destinationTarget

The actual object that is the target of the reference (Location/organization to which the patient is discharged.)

dietPreference

List<CodeableConcept> dietPreference

Diet preferences reported by the patient.

dischargeDisposition

CodeableConcept dischargeDisposition

Category or kind of location after discharge.

origin

Reference origin

The location/organization from which the patient came before admission.

originTarget

Resource originTarget

The actual object that is the target of the reference (The location/organization from which the patient came before admission.)

preAdmissionIdentifier

Identifier preAdmissionIdentifier

Pre-admission identifier.

reAdmission

CodeableConcept reAdmission

Whether this hospitalization is a readmission and why if known.

specialArrangement

List<CodeableConcept> specialArrangement

Any special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things.

specialCourtesy

List<CodeableConcept> specialCourtesy

Special courtesies (VIP, board member).

Class org.hl7.fhir.r4.model.Encounter.EncounterLocationComponent

class EncounterLocationComponent extends BackboneElement implements Serializable

serialVersionUID:

-755081862L

Serialized Fields

location

Reference location

The location where the encounter takes place.

locationTarget

Location locationTarget

The actual object that is the target of the reference (The location where the encounter takes place.)

period

Period period

Time period during which the patient was present at the location.

physicalType

CodeableConcept physicalType

This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query.

status

Enumeration<Encounter.EncounterLocationStatus> status

The status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time.

Class org.hl7.fhir.r4.model.Encounter.EncounterLocationStatusEnumFactory

class EncounterLocationStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Encounter.EncounterParticipantComponent

class EncounterParticipantComponent extends BackboneElement implements Serializable

serialVersionUID:

317095765L

Serialized Fields

individual

Reference individual

Persons involved in the encounter other than the patient.

individualTarget

Resource individualTarget

The actual object that is the target of the reference (Persons involved in the encounter other than the patient.)

period

Period period

The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.

type

List<CodeableConcept> type

Role of participant in encounter.

Class org.hl7.fhir.r4.model.Encounter.EncounterStatusEnumFactory

class EncounterStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Encounter.StatusHistoryComponent

class StatusHistoryComponent extends BackboneElement implements Serializable

serialVersionUID:

-1893906736L

Serialized Fields

period

Period period

The time that the episode was in the specified status.

status

Enumeration<Encounter.EncounterStatus> status

planned | arrived | triaged | in-progress | onleave | finished | cancelled +.

Class org.hl7.fhir.r4.model.Endpoint

class Endpoint extends DomainResource implements Serializable

serialVersionUID:

755181080L

Serialized Fields

address

UrlType address

The uri that describes the actual end-point to connect to.

connectionType

Coding connectionType

A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).

contact

List<ContactPoint> contact

Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.

header

List<StringType> header

Additional headers / information to send as part of the notification.

identifier

List<Identifier> identifier

Identifier for the organization that is used to identify the endpoint across multiple disparate systems.

managingOrganization

Reference managingOrganization

The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).

managingOrganizationTarget

Organization managingOrganizationTarget

The actual object that is the target of the reference (The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).)

name

StringType name

A friendly name that this endpoint can be referred to with.

payloadMimeType

List<CodeType> payloadMimeType

The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).

payloadType

List<CodeableConcept> payloadType

The payload type describes the acceptable content that can be communicated on the endpoint.

period

Period period

The interval during which the endpoint is expected to be operational.

status

Enumeration<Endpoint.EndpointStatus> status

active | suspended | error | off | test.

Class org.hl7.fhir.r4.model.Endpoint.EndpointStatusEnumFactory

class EndpointStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.EnrollmentRequest

class EnrollmentRequest extends DomainResource implements Serializable

serialVersionUID:

631501951L

Serialized Fields

candidate

Reference candidate

Patient Resource.

candidateTarget

Patient candidateTarget

The actual object that is the target of the reference (Patient Resource.)

coverage

Reference coverage

Reference to the program or plan identification, underwriter or payor.

coverageTarget

Coverage coverageTarget

The actual object that is the target of the reference (Reference to the program or plan identification, underwriter or payor.)

created

DateTimeType created

The date when this resource was created.

identifier

List<Identifier> identifier

The Response business identifier.

insurer

Reference insurer

The Insurer who is target of the request.

insurerTarget

Organization insurerTarget

The actual object that is the target of the reference (The Insurer who is target of the request.)

provider

Reference provider

The practitioner who is responsible for the services rendered to the patient.

providerTarget

Resource providerTarget

The actual object that is the target of the reference (The practitioner who is responsible for the services rendered to the patient.)

status

Enumeration<EnrollmentRequest.EnrollmentRequestStatus> status

The status of the resource instance.

Class org.hl7.fhir.r4.model.EnrollmentRequest.EnrollmentRequestStatusEnumFactory

class EnrollmentRequestStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.EnrollmentResponse

class EnrollmentResponse extends DomainResource implements Serializable

serialVersionUID:

-1759921458L

Serialized Fields

created

DateTimeType created

The date when the enclosed suite of services were performed or completed.

disposition

StringType disposition

A description of the status of the adjudication.

identifier

List<Identifier> identifier

The Response business identifier.

organization

Reference organization

The Insurer who produced this adjudicated response.

organizationTarget

Organization organizationTarget

The actual object that is the target of the reference (The Insurer who produced this adjudicated response.)

outcome

Enumeration<Enumerations.RemittanceOutcome> outcome

Processing status: error, complete.

request

Reference request

Original request resource reference.

requestProvider

Reference requestProvider

The practitioner who is responsible for the services rendered to the patient.

requestProviderTarget

Resource requestProviderTarget

The actual object that is the target of the reference (The practitioner who is responsible for the services rendered to the patient.)

requestTarget

EnrollmentRequest requestTarget

The actual object that is the target of the reference (Original request resource reference.)

status

Enumeration<EnrollmentResponse.EnrollmentResponseStatus> status

The status of the resource instance.

Class org.hl7.fhir.r4.model.EnrollmentResponse.EnrollmentResponseStatusEnumFactory

class EnrollmentResponseStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Enumeration

class Enumeration extends PrimitiveType<T extends Enum<?>> implements Externalizable

serialVersionUID:

1L

Serialization Methods

readExternal

public void readExternal(ObjectInput theIn)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput theOut)
                   throws IOException

Throws:

IOException

Class org.hl7.fhir.r4.model.Enumerations.AbstractTypeEnumFactory

class AbstractTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Enumerations.AdministrativeGenderEnumFactory

class AdministrativeGenderEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Enumerations.AgeUnitsEnumFactory

class AgeUnitsEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Enumerations.BindingStrengthEnumFactory

class BindingStrengthEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Enumerations.ConceptMapEquivalenceEnumFactory

class ConceptMapEquivalenceEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Enumerations.DataAbsentReasonEnumFactory

class DataAbsentReasonEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Enumerations.DataTypeEnumFactory

class DataTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Enumerations.DefinitionResourceTypeEnumFactory

class DefinitionResourceTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Enumerations.DocumentReferenceStatusEnumFactory

class DocumentReferenceStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Enumerations.EventResourceTypeEnumFactory

class EventResourceTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Enumerations.FHIRAllTypesEnumFactory

class FHIRAllTypesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Enumerations.FHIRDefinedTypeEnumFactory

class FHIRDefinedTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Enumerations.FHIRVersionEnumFactory

class FHIRVersionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Enumerations.KnowledgeResourceTypeEnumFactory

class KnowledgeResourceTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Enumerations.MessageEventEnumFactory

class MessageEventEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Enumerations.NoteTypeEnumFactory

class NoteTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Enumerations.PublicationStatusEnumFactory

class PublicationStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Enumerations.RemittanceOutcomeEnumFactory

class RemittanceOutcomeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Enumerations.RequestResourceTypeEnumFactory

class RequestResourceTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Enumerations.ResourceTypeEnumFactory

class ResourceTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Enumerations.SearchParamTypeEnumFactory

class SearchParamTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Enumerations.SpecialValuesEnumFactory

class SpecialValuesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.EpisodeOfCare

class EpisodeOfCare extends DomainResource implements Serializable

serialVersionUID:

548033949L

Serialized Fields

account

List<Reference> account

The set of accounts that may be used for billing for this EpisodeOfCare.

accountTarget

List<Account> accountTarget

The actual objects that are the target of the reference (The set of accounts that may be used for billing for this EpisodeOfCare.)

careManager

Reference careManager

The practitioner that is the care manager/care coordinator for this patient.

careManagerTarget

Resource careManagerTarget

The actual object that is the target of the reference (The practitioner that is the care manager/care coordinator for this patient.)

diagnosis

List<EpisodeOfCare.DiagnosisComponent> diagnosis

The list of diagnosis relevant to this episode of care.

identifier

List<Identifier> identifier

The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes.

managingOrganization

Reference managingOrganization

The organization that has assumed the specific responsibilities for the specified duration.

managingOrganizationTarget

Organization managingOrganizationTarget

The actual object that is the target of the reference (The organization that has assumed the specific responsibilities for the specified duration.)

patient

Reference patient

The patient who is the focus of this episode of care.

patientTarget

Patient patientTarget

The actual object that is the target of the reference (The patient who is the focus of this episode of care.)

period

Period period

The interval during which the managing organization assumes the defined responsibility.

referralRequest

List<Reference> referralRequest

Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.

referralRequestTarget

List<ServiceRequest> referralRequestTarget

The actual objects that are the target of the reference (Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.)

status

Enumeration<EpisodeOfCare.EpisodeOfCareStatus> status

planned | waitlist | active | onhold | finished | cancelled.

statusHistory

List<EpisodeOfCare.EpisodeOfCareStatusHistoryComponent> statusHistory

The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).

team

List<Reference> team

The list of practitioners that may be facilitating this episode of care for specific purposes.

teamTarget

List<CareTeam> teamTarget

The actual objects that are the target of the reference (The list of practitioners that may be facilitating this episode of care for specific purposes.)

type

List<CodeableConcept> type

A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care.

Class org.hl7.fhir.r4.model.EpisodeOfCare.DiagnosisComponent

class DiagnosisComponent extends BackboneElement implements Serializable

serialVersionUID:

249445632L

Serialized Fields

condition

Reference condition

A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for.

conditionTarget

Condition conditionTarget

The actual object that is the target of the reference (A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for.)

rank

PositiveIntType rank

Ranking of the diagnosis (for each role type).

role

CodeableConcept role

Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge ?).

Class org.hl7.fhir.r4.model.EpisodeOfCare.EpisodeOfCareStatusEnumFactory

class EpisodeOfCareStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.EpisodeOfCare.EpisodeOfCareStatusHistoryComponent

class EpisodeOfCareStatusHistoryComponent extends BackboneElement implements Serializable

serialVersionUID:

-1192432864L

Serialized Fields

period

Period period

The period during this EpisodeOfCare that the specific status applied.

status

Enumeration<EpisodeOfCare.EpisodeOfCareStatus> status

planned | waitlist | active | onhold | finished | cancelled.

Class org.hl7.fhir.r4.model.EventDefinition

class EventDefinition extends MetadataResource implements Serializable

serialVersionUID:

1022506246L

Serialized Fields

approvalDate

DateType approvalDate

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

author

List<ContactDetail> author

An individiual or organization primarily involved in the creation and maintenance of the content.

copyright

MarkdownType copyright

A copyright statement relating to the event definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the event definition.

editor

List<ContactDetail> editor

An individual or organization primarily responsible for internal coherence of the content.

effectivePeriod

Period effectivePeriod

The period during which the event definition content was or is planned to be in active use.

endorser

List<ContactDetail> endorser

An individual or organization responsible for officially endorsing the content for use in some setting.

identifier

List<Identifier> identifier

A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

lastReviewDate

DateType lastReviewDate

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

purpose

MarkdownType purpose

Explanation of why this event definition is needed and why it has been designed as it has.

relatedArtifact

List<RelatedArtifact> relatedArtifact

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

reviewer

List<ContactDetail> reviewer

An individual or organization primarily responsible for review of some aspect of the content.

subject

Type subject

A code or group definition that describes the intended subject of the event definition.

subtitle

StringType subtitle

An explanatory or alternate title for the event definition giving additional information about its content.

topic

List<CodeableConcept> topic

Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.

trigger

List<TriggerDefinition> trigger

The trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one of the trigger conditions is met.

usage

StringType usage

A detailed description of how the event definition is used from a clinical perspective.

Class org.hl7.fhir.r4.model.Evidence

class Evidence extends MetadataResource implements Serializable

serialVersionUID:

137844509L

Serialized Fields

approvalDate

DateType approvalDate

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

author

List<ContactDetail> author

An individiual or organization primarily involved in the creation and maintenance of the content.

copyright

MarkdownType copyright

A copyright statement relating to the evidence and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the evidence.

editor

List<ContactDetail> editor

An individual or organization primarily responsible for internal coherence of the content.

effectivePeriod

Period effectivePeriod

The period during which the evidence content was or is planned to be in active use.

endorser

List<ContactDetail> endorser

An individual or organization responsible for officially endorsing the content for use in some setting.

exposureBackground

Reference exposureBackground

A reference to a EvidenceVariable resource that defines the population for the research.

exposureBackgroundTarget

EvidenceVariable exposureBackgroundTarget

The actual object that is the target of the reference (A reference to a EvidenceVariable resource that defines the population for the research.)

exposureVariant

List<Reference> exposureVariant

A reference to a EvidenceVariable resource that defines the exposure for the research.

exposureVariantTarget

List<EvidenceVariable> exposureVariantTarget

The actual objects that are the target of the reference (A reference to a EvidenceVariable resource that defines the exposure for the research.)

identifier

List<Identifier> identifier

A formal identifier that is used to identify this evidence when it is represented in other formats, or referenced in a specification, model, design or an instance.

lastReviewDate

DateType lastReviewDate

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

note

List<Annotation> note

A human-readable string to clarify or explain concepts about the resource.

outcome

List<Reference> outcome

A reference to a EvidenceVariable resomece that defines the outcome for the research.

outcomeTarget

List<EvidenceVariable> outcomeTarget

The actual objects that are the target of the reference (A reference to a EvidenceVariable resomece that defines the outcome for the research.)

relatedArtifact

List<RelatedArtifact> relatedArtifact

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

reviewer

List<ContactDetail> reviewer

An individual or organization primarily responsible for review of some aspect of the content.

shortTitle

StringType shortTitle

The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.

subtitle

StringType subtitle

An explanatory or alternate title for the Evidence giving additional information about its content.

topic

List<CodeableConcept> topic

Descriptive topics related to the content of the Evidence. Topics provide a high-level categorization grouping types of Evidences that can be useful for filtering and searching.

Class org.hl7.fhir.r4.model.EvidenceVariable

class EvidenceVariable extends MetadataResource implements Serializable

serialVersionUID:

-317280154L

Serialized Fields

approvalDate

DateType approvalDate

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

author

List<ContactDetail> author

An individiual or organization primarily involved in the creation and maintenance of the content.

characteristic

List<EvidenceVariable.EvidenceVariableCharacteristicComponent> characteristic

A characteristic that defines the members of the evidence element. Multiple characteristics are applied with "and" semantics.

copyright

MarkdownType copyright

A copyright statement relating to the evidence variable and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the evidence variable.

editor

List<ContactDetail> editor

An individual or organization primarily responsible for internal coherence of the content.

effectivePeriod

Period effectivePeriod

The period during which the evidence variable content was or is planned to be in active use.

endorser

List<ContactDetail> endorser

An individual or organization responsible for officially endorsing the content for use in some setting.

identifier

List<Identifier> identifier

A formal identifier that is used to identify this evidence variable when it is represented in other formats, or referenced in a specification, model, design or an instance.

lastReviewDate

DateType lastReviewDate

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

note

List<Annotation> note

A human-readable string to clarify or explain concepts about the resource.

relatedArtifact

List<RelatedArtifact> relatedArtifact

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

reviewer

List<ContactDetail> reviewer

An individual or organization primarily responsible for review of some aspect of the content.

shortTitle

StringType shortTitle

The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.

subtitle

StringType subtitle

An explanatory or alternate title for the EvidenceVariable giving additional information about its content.

topic

List<CodeableConcept> topic

Descriptive topics related to the content of the EvidenceVariable. Topics provide a high-level categorization grouping types of EvidenceVariables that can be useful for filtering and searching.

type

Enumeration<EvidenceVariable.EvidenceVariableType> type

The type of evidence element, a population, an exposure, or an outcome.

Class org.hl7.fhir.r4.model.EvidenceVariable.EvidenceVariableCharacteristicComponent

class EvidenceVariableCharacteristicComponent extends BackboneElement implements Serializable

serialVersionUID:

1901961318L

Serialized Fields

definition

Type definition

Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).

description

StringType description

A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user.

exclude

BooleanType exclude

When true, members with this characteristic are excluded from the element.

groupMeasure

Enumeration<EvidenceVariable.GroupMeasure> groupMeasure

Indicates how elements are aggregated within the study effective period.

participantEffective

Type participantEffective

Indicates what effective period the study covers.

timeFromStart

Duration timeFromStart

Indicates duration from the participant's study entry.

usageContext

List<UsageContext> usageContext

Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.

Class org.hl7.fhir.r4.model.EvidenceVariable.EvidenceVariableTypeEnumFactory

class EvidenceVariableTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.EvidenceVariable.GroupMeasureEnumFactory

class GroupMeasureEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ExampleScenario

class ExampleScenario extends MetadataResource implements Serializable

serialVersionUID:

758248907L

Serialized Fields

actor

List<ExampleScenario.ExampleScenarioActorComponent> actor

Actor participating in the resource.

copyright

MarkdownType copyright

A copyright statement relating to the example scenario and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the example scenario.

identifier

List<Identifier> identifier

A formal identifier that is used to identify this example scenario when it is represented in other formats, or referenced in a specification, model, design or an instance.

instance

List<ExampleScenario.ExampleScenarioInstanceComponent> instance

Each resource and each version that is present in the workflow.

process

List<ExampleScenario.ExampleScenarioProcessComponent> process

Each major process - a group of operations.

purpose

MarkdownType purpose

What the example scenario resource is created for. This should not be used to show the business purpose of the scenario itself, but the purpose of documenting a scenario.

workflow

List<CanonicalType> workflow

Another nested workflow.

Class org.hl7.fhir.r4.model.ExampleScenario.ExampleScenarioActorComponent

class ExampleScenarioActorComponent extends BackboneElement implements Serializable

serialVersionUID:

1348364162L

Serialized Fields

actorId

StringType actorId

ID or acronym of actor.

description

MarkdownType description

The description of the actor.

name

StringType name

The name of the actor as shown in the page.

type

Enumeration<ExampleScenario.ExampleScenarioActorType> type

The type of actor - person or system.

Class org.hl7.fhir.r4.model.ExampleScenario.ExampleScenarioActorTypeEnumFactory

class ExampleScenarioActorTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ExampleScenario.ExampleScenarioInstanceComponent

class ExampleScenarioInstanceComponent extends BackboneElement implements Serializable

serialVersionUID:

-1131860669L

Serialized Fields

containedInstance

List<ExampleScenario.ExampleScenarioInstanceContainedInstanceComponent> containedInstance

Resources contained in the instance (e.g. the observations contained in a bundle).

description

MarkdownType description

Human-friendly description of the resource instance.

name

StringType name

A short name for the resource instance.

resourceId

StringType resourceId

The id of the resource for referencing.

resourceType

Enumeration<ExampleScenario.FHIRResourceType> resourceType

The type of the resource.

version

List<ExampleScenario.ExampleScenarioInstanceVersionComponent> version

A specific version of the resource.

Class org.hl7.fhir.r4.model.ExampleScenario.ExampleScenarioInstanceContainedInstanceComponent

class ExampleScenarioInstanceContainedInstanceComponent extends BackboneElement implements Serializable

serialVersionUID:

908084124L

Serialized Fields

resourceId

StringType resourceId

Each resource contained in the instance.

versionId

StringType versionId

A specific version of a resource contained in the instance.

Class org.hl7.fhir.r4.model.ExampleScenario.ExampleScenarioInstanceVersionComponent

class ExampleScenarioInstanceVersionComponent extends BackboneElement implements Serializable

serialVersionUID:

960821913L

Serialized Fields

description

MarkdownType description

The description of the resource version.

versionId

StringType versionId

The identifier of a specific version of a resource.

Class org.hl7.fhir.r4.model.ExampleScenario.ExampleScenarioProcessComponent

class ExampleScenarioProcessComponent extends BackboneElement implements Serializable

serialVersionUID:

325578043L

Serialized Fields

description

MarkdownType description

A longer description of the group of operations.

postConditions

MarkdownType postConditions

Description of final status after the process ends.

preConditions

MarkdownType preConditions

Description of initial status before the process starts.

step

List<ExampleScenario.ExampleScenarioProcessStepComponent> step

Each step of the process.

title

StringType title

The diagram title of the group of operations.

Class org.hl7.fhir.r4.model.ExampleScenario.ExampleScenarioProcessStepAlternativeComponent

class ExampleScenarioProcessStepAlternativeComponent extends BackboneElement implements Serializable

serialVersionUID:

-254687460L

Serialized Fields

description

MarkdownType description

A human-readable description of the alternative explaining when the alternative should occur rather than the base step.

step

List<ExampleScenario.ExampleScenarioProcessStepComponent> step

What happens in each alternative option.

title

StringType title

The label to display for the alternative that gives a sense of the circumstance in which the alternative should be invoked.

Class org.hl7.fhir.r4.model.ExampleScenario.ExampleScenarioProcessStepComponent

class ExampleScenarioProcessStepComponent extends BackboneElement implements Serializable

serialVersionUID:

-894029605L

Serialized Fields

alternative

List<ExampleScenario.ExampleScenarioProcessStepAlternativeComponent> alternative

Indicates an alternative step that can be taken instead of the operations on the base step in exceptional/atypical circumstances.

operation

ExampleScenario.ExampleScenarioProcessStepOperationComponent operation

Each interaction or action.

pause

BooleanType pause

If there is a pause in the flow.

process

List<ExampleScenario.ExampleScenarioProcessComponent> process

Nested process.

Class org.hl7.fhir.r4.model.ExampleScenario.ExampleScenarioProcessStepOperationComponent

class ExampleScenarioProcessStepOperationComponent extends BackboneElement implements Serializable

serialVersionUID:

911241906L

Serialized Fields

description

MarkdownType description

A comment to be inserted in the diagram.

initiator

StringType initiator

Who starts the transaction.

initiatorActive

BooleanType initiatorActive

Whether the initiator is deactivated right after the transaction.

name

StringType name

The human-friendly name of the interaction.

number

StringType number

The sequential number of the interaction, e.g. 1.2.5.

receiver

StringType receiver

Who receives the transaction.

receiverActive

BooleanType receiverActive

Whether the receiver is deactivated right after the transaction.

request

ExampleScenario.ExampleScenarioInstanceContainedInstanceComponent request

Each resource instance used by the initiator.

response

ExampleScenario.ExampleScenarioInstanceContainedInstanceComponent response

Each resource instance used by the responder.

type

StringType type

The type of operation - CRUD.

Class org.hl7.fhir.r4.model.ExampleScenario.FHIRResourceTypeEnumFactory

class FHIRResourceTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ExplanationOfBenefit

class ExplanationOfBenefit extends DomainResource implements Serializable

serialVersionUID:

-1515422099L

Serialized Fields

accident

ExplanationOfBenefit.AccidentComponent accident

Details of a accident which resulted in injuries which required the products and services listed in the claim.

addItem

List<ExplanationOfBenefit.AddedItemComponent> addItem

The first-tier service adjudications for payor added product or service lines.

adjudication

List<ExplanationOfBenefit.AdjudicationComponent> adjudication

The adjudication results which are presented at the header level rather than at the line-item or add-item levels.

benefitBalance

List<ExplanationOfBenefit.BenefitBalanceComponent> benefitBalance

Balance by Benefit Category.

benefitPeriod

Period benefitPeriod

The term of the benefits documented in this response.

billablePeriod

Period billablePeriod

The period for which charges are being submitted.

careTeam

List<ExplanationOfBenefit.CareTeamComponent> careTeam

The members of the team who provided the products and services.

claim

Reference claim

The business identifier for the instance of the adjudication request: claim predetermination or preauthorization.

claimResponse

Reference claimResponse

The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response.

claimResponseTarget

ClaimResponse claimResponseTarget

The actual object that is the target of the reference (The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response.)

claimTarget

Claim claimTarget

The actual object that is the target of the reference (The business identifier for the instance of the adjudication request: claim predetermination or preauthorization.)

created

DateTimeType created

The date this resource was created.

diagnosis

List<ExplanationOfBenefit.DiagnosisComponent> diagnosis

Information about diagnoses relevant to the claim items.

disposition

StringType disposition

A human readable description of the status of the adjudication.

enterer

Reference enterer

Individual who created the claim, predetermination or preauthorization.

entererTarget

Resource entererTarget

The actual object that is the target of the reference (Individual who created the claim, predetermination or preauthorization.)

facility

Reference facility

Facility where the services were provided.

facilityTarget

Location facilityTarget

The actual object that is the target of the reference (Facility where the services were provided.)

form

Attachment form

The actual form, by reference or inclusion, for printing the content or an EOB.

formCode

CodeableConcept formCode

A code for the form to be used for printing the content.

fundsReserve

CodeableConcept fundsReserve

A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.

fundsReserveRequested

CodeableConcept fundsReserveRequested

A code to indicate whether and for whom funds are to be reserved for future claims.

identifier

List<Identifier> identifier

A unique identifier assigned to this explanation of benefit.

insurance

List<ExplanationOfBenefit.InsuranceComponent> insurance

Financial instruments for reimbursement for the health care products and services specified on the claim.

insurer

Reference insurer

The party responsible for authorization, adjudication and reimbursement.

insurerTarget

Organization insurerTarget

The actual object that is the target of the reference (The party responsible for authorization, adjudication and reimbursement.)

item

List<ExplanationOfBenefit.ItemComponent> item

A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.

originalPrescription

Reference originalPrescription

Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.

originalPrescriptionTarget

MedicationRequest originalPrescriptionTarget

The actual object that is the target of the reference (Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.)

outcome

Enumeration<ExplanationOfBenefit.RemittanceOutcome> outcome

The outcome of the claim, predetermination, or preauthorization processing.

patient

Reference patient

The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for forecast reimbursement is sought.

patientTarget

Patient patientTarget

The actual object that is the target of the reference (The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for forecast reimbursement is sought.)

payee

ExplanationOfBenefit.PayeeComponent payee

The party to be reimbursed for cost of the products and services according to the terms of the policy.

payment

ExplanationOfBenefit.PaymentComponent payment

Payment details for the adjudication of the claim.

preAuthRef

List<StringType> preAuthRef

Reference from the Insurer which is used in later communications which refers to this adjudication.

preAuthRefPeriod

List<Period> preAuthRefPeriod

The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided.

precedence

PositiveIntType precedence

This indicates the relative order of a series of EOBs related to different coverages for the same suite of services.

prescription

Reference prescription

Prescription to support the dispensing of pharmacy, device or vision products.

prescriptionTarget

Resource prescriptionTarget

The actual object that is the target of the reference (Prescription to support the dispensing of pharmacy, device or vision products.)

priority

CodeableConcept priority

The provider-required urgency of processing the request. Typical values include: stat, routine deferred.

procedure

List<ExplanationOfBenefit.ProcedureComponent> procedure

Procedures performed on the patient relevant to the billing items with the claim.

processNote

List<ExplanationOfBenefit.NoteComponent> processNote

A note that describes or explains adjudication results in a human readable form.

provider

Reference provider

The provider which is responsible for the claim, predetermination or preauthorization.

providerTarget

Resource providerTarget

The actual object that is the target of the reference (The provider which is responsible for the claim, predetermination or preauthorization.)

referral

Reference referral

A reference to a referral resource.

referralTarget

ServiceRequest referralTarget

The actual object that is the target of the reference (A reference to a referral resource.)

related

List<ExplanationOfBenefit.RelatedClaimComponent> related

Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.

status

Enumeration<ExplanationOfBenefit.ExplanationOfBenefitStatus> status

The status of the resource instance.

subType

CodeableConcept subType

A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

supportingInfo

List<ExplanationOfBenefit.SupportingInformationComponent> supportingInfo

Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.

total

List<ExplanationOfBenefit.TotalComponent> total

Categorized monetary totals for the adjudication.

type

CodeableConcept type

The category of claim, e.g. oral, pharmacy, vision, institutional, professional.

use

Enumeration<ExplanationOfBenefit.Use> use

A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.

Class org.hl7.fhir.r4.model.ExplanationOfBenefit.AccidentComponent

class AccidentComponent extends BackboneElement implements Serializable

serialVersionUID:

622904984L

Serialized Fields

date

DateType date

Date of an accident event related to the products and services contained in the claim.

location

Type location

The physical location of the accident event.

type

CodeableConcept type

The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers.

Class org.hl7.fhir.r4.model.ExplanationOfBenefit.AddedItemComponent

class AddedItemComponent extends BackboneElement implements Serializable

serialVersionUID:

-206524210L

Serialized Fields

adjudication

List<ExplanationOfBenefit.AdjudicationComponent> adjudication

The adjudication results.

bodySite

CodeableConcept bodySite

Physical service site on the patient (limb, tooth, etc.).

detail

List<ExplanationOfBenefit.AddedItemDetailComponent> detail

The second-tier service adjudications for payor added services.

detailSequence

List<PositiveIntType> detailSequence

The sequence number of the details within the claim item which this line is intended to replace.

factor

DecimalType factor

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

itemSequence

List<PositiveIntType> itemSequence

Claim items which this service line is intended to replace.

location

Type location

Where the product or service was provided.

modifier

List<CodeableConcept> modifier

Item typification or modifiers codes to convey additional context for the product or service.

net

Money net

The quantity times the unit price for an additional service or product or charge.

noteNumber

List<PositiveIntType> noteNumber

The numbers associated with notes below which apply to the adjudication of this item.

productOrService

CodeableConcept productOrService

When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

programCode

List<CodeableConcept> programCode

Identifies the program under which this may be recovered.

provider

List<Reference> provider

The providers who are authorized for the services rendered to the patient.

providerTarget

List<Resource> providerTarget

The actual objects that are the target of the reference (The providers who are authorized for the services rendered to the patient.)

quantity

Quantity quantity

The number of repetitions of a service or product.

serviced

Type serviced

The date or dates when the service or product was supplied, performed or completed.

subDetailSequence

List<PositiveIntType> subDetailSequence

The sequence number of the sub-details woithin the details within the claim item which this line is intended to replace.

subSite

List<CodeableConcept> subSite

A region or surface of the bodySite, e.g. limb region or tooth surface(s).

unitPrice

Money unitPrice

If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

Class org.hl7.fhir.r4.model.ExplanationOfBenefit.AddedItemDetailComponent

class AddedItemDetailComponent extends BackboneElement implements Serializable

serialVersionUID:

295910869L

Serialized Fields

adjudication

List<ExplanationOfBenefit.AdjudicationComponent> adjudication

The adjudication results.

factor

DecimalType factor

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

modifier

List<CodeableConcept> modifier

Item typification or modifiers codes to convey additional context for the product or service.

net

Money net

The quantity times the unit price for an additional service or product or charge.

noteNumber

List<PositiveIntType> noteNumber

The numbers associated with notes below which apply to the adjudication of this item.

productOrService

CodeableConcept productOrService

When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

quantity

Quantity quantity

The number of repetitions of a service or product.

subDetail

List<ExplanationOfBenefit.AddedItemDetailSubDetailComponent> subDetail

The third-tier service adjudications for payor added services.

unitPrice

Money unitPrice

If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

Class org.hl7.fhir.r4.model.ExplanationOfBenefit.AddedItemDetailSubDetailComponent

class AddedItemDetailSubDetailComponent extends BackboneElement implements Serializable

serialVersionUID:

1301363592L

Serialized Fields

adjudication

List<ExplanationOfBenefit.AdjudicationComponent> adjudication

The adjudication results.

factor

DecimalType factor

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

modifier

List<CodeableConcept> modifier

Item typification or modifiers codes to convey additional context for the product or service.

net

Money net

The quantity times the unit price for an additional service or product or charge.

noteNumber

List<PositiveIntType> noteNumber

The numbers associated with notes below which apply to the adjudication of this item.

productOrService

CodeableConcept productOrService

When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

quantity

Quantity quantity

The number of repetitions of a service or product.

unitPrice

Money unitPrice

If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

Class org.hl7.fhir.r4.model.ExplanationOfBenefit.AdjudicationComponent

class AdjudicationComponent extends BackboneElement implements Serializable

serialVersionUID:

1559898786L

Serialized Fields

amount

Money amount

Monetary amount associated with the category.

category

CodeableConcept category

A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in-aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

reason

CodeableConcept reason

A code supporting the understanding of the adjudication result and explaining variance from expected amount.

value

DecimalType value

A non-monetary value associated with the category. Mutually exclusive to the amount element above.

Class org.hl7.fhir.r4.model.ExplanationOfBenefit.BenefitBalanceComponent

class BenefitBalanceComponent extends BackboneElement implements Serializable

serialVersionUID:

-1889655824L

Serialized Fields

category

CodeableConcept category

Code to identify the general type of benefits under which products and services are provided.

description

StringType description

A richer description of the benefit or services covered.

excluded

BooleanType excluded

True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.

financial

List<ExplanationOfBenefit.BenefitComponent> financial

Benefits Used to date.

name

StringType name

A short name or tag for the benefit.

network

CodeableConcept network

Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.

term

CodeableConcept term

The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.

unit

CodeableConcept unit

Indicates if the benefits apply to an individual or to the family.

Class org.hl7.fhir.r4.model.ExplanationOfBenefit.BenefitComponent

class BenefitComponent extends BackboneElement implements Serializable

serialVersionUID:

-1506285314L

Serialized Fields

allowed

Type allowed

The quantity of the benefit which is permitted under the coverage.

type

CodeableConcept type

Classification of benefit being provided.

used

Type used

The quantity of the benefit which have been consumed to date.

Class org.hl7.fhir.r4.model.ExplanationOfBenefit.CareTeamComponent

class CareTeamComponent extends BackboneElement implements Serializable

serialVersionUID:

1758966968L

Serialized Fields

provider

Reference provider

Member of the team who provided the product or service.

providerTarget

Resource providerTarget

The actual object that is the target of the reference (Member of the team who provided the product or service.)

qualification

CodeableConcept qualification

The qualification of the practitioner which is applicable for this service.

responsible

BooleanType responsible

The party who is billing and/or responsible for the claimed products or services.

role

CodeableConcept role

The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team.

sequence

PositiveIntType sequence

A number to uniquely identify care team entries.

Class org.hl7.fhir.r4.model.ExplanationOfBenefit.DetailComponent

class DetailComponent extends BackboneElement implements Serializable

serialVersionUID:

225639798L

Serialized Fields

adjudication

List<ExplanationOfBenefit.AdjudicationComponent> adjudication

The adjudication results.

category

CodeableConcept category

Code to identify the general type of benefits under which products and services are provided.

factor

DecimalType factor

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

modifier

List<CodeableConcept> modifier

Item typification or modifiers codes to convey additional context for the product or service.

net

Money net

The quantity times the unit price for an additional service or product or charge.

noteNumber

List<PositiveIntType> noteNumber

The numbers associated with notes below which apply to the adjudication of this item.

productOrService

CodeableConcept productOrService

When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

programCode

List<CodeableConcept> programCode

Identifies the program under which this may be recovered.

quantity

Quantity quantity

The number of repetitions of a service or product.

revenue

CodeableConcept revenue

The type of revenue or cost center providing the product and/or service.

sequence

PositiveIntType sequence

A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

subDetail

List<ExplanationOfBenefit.SubDetailComponent> subDetail

Third-tier of goods and services.

udi

List<Reference> udi

Unique Device Identifiers associated with this line item.

udiTarget

List<Device> udiTarget

The actual objects that are the target of the reference (Unique Device Identifiers associated with this line item.)

unitPrice

Money unitPrice

If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

Class org.hl7.fhir.r4.model.ExplanationOfBenefit.DiagnosisComponent

class DiagnosisComponent extends BackboneElement implements Serializable

serialVersionUID:

2120593974L

Serialized Fields

diagnosis

Type diagnosis

The nature of illness or problem in a coded form or as a reference to an external defined Condition.

onAdmission

CodeableConcept onAdmission

Indication of whether the diagnosis was present on admission to a facility.

packageCode

CodeableConcept packageCode

A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.

sequence

PositiveIntType sequence

A number to uniquely identify diagnosis entries.

type

List<CodeableConcept> type

When the condition was observed or the relative ranking.

Class org.hl7.fhir.r4.model.ExplanationOfBenefit.ExplanationOfBenefitStatusEnumFactory

class ExplanationOfBenefitStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ExplanationOfBenefit.InsuranceComponent

class InsuranceComponent extends BackboneElement implements Serializable

serialVersionUID:

-606383626L

Serialized Fields

coverage

Reference coverage

Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.

coverageTarget

Coverage coverageTarget

The actual object that is the target of the reference (Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.)

focal

BooleanType focal

A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.

preAuthRef

List<StringType> preAuthRef

Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization.

Class org.hl7.fhir.r4.model.ExplanationOfBenefit.ItemComponent

class ItemComponent extends BackboneElement implements Serializable

serialVersionUID:

67419471L

Serialized Fields

adjudication

List<ExplanationOfBenefit.AdjudicationComponent> adjudication

If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.

bodySite

CodeableConcept bodySite

Physical service site on the patient (limb, tooth, etc.).

careTeamSequence

List<PositiveIntType> careTeamSequence

Care team members related to this service or product.

category

CodeableConcept category

Code to identify the general type of benefits under which products and services are provided.

detail

List<ExplanationOfBenefit.DetailComponent> detail

Second-tier of goods and services.

diagnosisSequence

List<PositiveIntType> diagnosisSequence

Diagnoses applicable for this service or product.

encounter

List<Reference> encounter

A billed item may include goods or services provided in multiple encounters.

encounterTarget

List<Encounter> encounterTarget

The actual objects that are the target of the reference (A billed item may include goods or services provided in multiple encounters.)

factor

DecimalType factor

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

informationSequence

List<PositiveIntType> informationSequence

Exceptions, special conditions and supporting information applicable for this service or product.

location

Type location

Where the product or service was provided.

modifier

List<CodeableConcept> modifier

Item typification or modifiers codes to convey additional context for the product or service.

net

Money net

The quantity times the unit price for an additional service or product or charge.

noteNumber

List<PositiveIntType> noteNumber

The numbers associated with notes below which apply to the adjudication of this item.

procedureSequence

List<PositiveIntType> procedureSequence

Procedures applicable for this service or product.

productOrService

CodeableConcept productOrService

When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

programCode

List<CodeableConcept> programCode

Identifies the program under which this may be recovered.

quantity

Quantity quantity

The number of repetitions of a service or product.

revenue

CodeableConcept revenue

The type of revenue or cost center providing the product and/or service.

sequence

PositiveIntType sequence

A number to uniquely identify item entries.

serviced

Type serviced

The date or dates when the service or product was supplied, performed or completed.

subSite

List<CodeableConcept> subSite

A region or surface of the bodySite, e.g. limb region or tooth surface(s).

udi

List<Reference> udi

Unique Device Identifiers associated with this line item.

udiTarget

List<Device> udiTarget

The actual objects that are the target of the reference (Unique Device Identifiers associated with this line item.)

unitPrice

Money unitPrice

If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

Class org.hl7.fhir.r4.model.ExplanationOfBenefit.NoteComponent

class NoteComponent extends BackboneElement implements Serializable

serialVersionUID:

-385184277L

Serialized Fields

language

CodeableConcept language

A code to define the language used in the text of the note.

number

PositiveIntType number

A number to uniquely identify a note entry.

text

StringType text

The explanation or description associated with the processing.

type

Enumeration<Enumerations.NoteType> type

The business purpose of the note text.

Class org.hl7.fhir.r4.model.ExplanationOfBenefit.PayeeComponent

class PayeeComponent extends BackboneElement implements Serializable

serialVersionUID:

1609484699L

Serialized Fields

party

Reference party

Reference to the individual or organization to whom any payment will be made.

partyTarget

Resource partyTarget

The actual object that is the target of the reference (Reference to the individual or organization to whom any payment will be made.)

type

CodeableConcept type

Type of Party to be reimbursed: Subscriber, provider, other.

Class org.hl7.fhir.r4.model.ExplanationOfBenefit.PaymentComponent

class PaymentComponent extends BackboneElement implements Serializable

serialVersionUID:

1539906026L

Serialized Fields

adjustment

Money adjustment

Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication.

adjustmentReason

CodeableConcept adjustmentReason

Reason for the payment adjustment.

amount

Money amount

Benefits payable less any payment adjustment.

date

DateType date

Estimated date the payment will be issued or the actual issue date of payment.

identifier

Identifier identifier

Issuer's unique identifier for the payment instrument.

type

CodeableConcept type

Whether this represents partial or complete payment of the benefits payable.

Class org.hl7.fhir.r4.model.ExplanationOfBenefit.ProcedureComponent

class ProcedureComponent extends BackboneElement implements Serializable

serialVersionUID:

935341852L

Serialized Fields

date

DateTimeType date

Date and optionally time the procedure was performed.

procedure

Type procedure

The code or reference to a Procedure resource which identifies the clinical intervention performed.

sequence

PositiveIntType sequence

A number to uniquely identify procedure entries.

type

List<CodeableConcept> type

When the condition was observed or the relative ranking.

udi

List<Reference> udi

Unique Device Identifiers associated with this line item.

udiTarget

List<Device> udiTarget

The actual objects that are the target of the reference (Unique Device Identifiers associated with this line item.)

Class org.hl7.fhir.r4.model.ExplanationOfBenefit.RelatedClaimComponent

class RelatedClaimComponent extends BackboneElement implements Serializable

serialVersionUID:

-379338905L

Serialized Fields

claim

Reference claim

Reference to a related claim.

claimTarget

Claim claimTarget

The actual object that is the target of the reference (Reference to a related claim.)

reference

Identifier reference

An alternate organizational reference to the case or file to which this particular claim pertains.

relationship

CodeableConcept relationship

A code to convey how the claims are related.

Class org.hl7.fhir.r4.model.ExplanationOfBenefit.RemittanceOutcomeEnumFactory

class RemittanceOutcomeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ExplanationOfBenefit.SubDetailComponent

class SubDetailComponent extends BackboneElement implements Serializable

serialVersionUID:

-996156853L

Serialized Fields

adjudication

List<ExplanationOfBenefit.AdjudicationComponent> adjudication

The adjudication results.

category

CodeableConcept category

Code to identify the general type of benefits under which products and services are provided.

factor

DecimalType factor

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

modifier

List<CodeableConcept> modifier

Item typification or modifiers codes to convey additional context for the product or service.

net

Money net

The quantity times the unit price for an additional service or product or charge.

noteNumber

List<PositiveIntType> noteNumber

The numbers associated with notes below which apply to the adjudication of this item.

productOrService

CodeableConcept productOrService

When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

programCode

List<CodeableConcept> programCode

Identifies the program under which this may be recovered.

quantity

Quantity quantity

The number of repetitions of a service or product.

revenue

CodeableConcept revenue

The type of revenue or cost center providing the product and/or service.

sequence

PositiveIntType sequence

A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

udi

List<Reference> udi

Unique Device Identifiers associated with this line item.

udiTarget

List<Device> udiTarget

The actual objects that are the target of the reference (Unique Device Identifiers associated with this line item.)

unitPrice

Money unitPrice

If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.

Class org.hl7.fhir.r4.model.ExplanationOfBenefit.SupportingInformationComponent

class SupportingInformationComponent extends BackboneElement implements Serializable

serialVersionUID:

-410136661L

Serialized Fields

category

CodeableConcept category

The general class of the information supplied: information; exception; accident, employment; onset, etc.

code

CodeableConcept code

System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.

reason

Coding reason

Provides the reason in the situation where a reason code is required in addition to the content.

sequence

PositiveIntType sequence

A number to uniquely identify supporting information entries.

timing

Type timing

The date when or period to which this information refers.

value

Type value

Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.

Class org.hl7.fhir.r4.model.ExplanationOfBenefit.TotalComponent

class TotalComponent extends BackboneElement implements Serializable

serialVersionUID:

2012310309L

Serialized Fields

amount

Money amount

Monetary total amount associated with the category.

category

CodeableConcept category

A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.

Class org.hl7.fhir.r4.model.ExplanationOfBenefit.UseEnumFactory

class UseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Expression

class Expression extends Type implements Serializable

serialVersionUID:

-941986742L

Serialized Fields

description

StringType description

A brief, natural language description of the condition that effectively communicates the intended semantics.

expression

StringType expression

An expression in the specified language that returns a value.

language

CodeType language

The media type of the language for the expression.

name

IdType name

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

reference

UriType reference

A URI that defines where the expression is found.

Class org.hl7.fhir.r4.model.Expression.ExpressionLanguageEnumFactory

class ExpressionLanguageEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Extension

class Extension extends BaseExtension implements Serializable

serialVersionUID:

194602931L

Serialized Fields

url

UriType url

Source of the definition for the extension code - a logical name or a URL.

value

Type value

Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).

Class org.hl7.fhir.r4.model.FamilyMemberHistory

class FamilyMemberHistory extends DomainResource implements Serializable

serialVersionUID:

-455261406L

Serialized Fields

age

Type age

The age of the relative at the time the family member history is recorded.

born

Type born

The actual or approximate date of birth of the relative.

condition

List<FamilyMemberHistory.FamilyMemberHistoryConditionComponent> condition

The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.

dataAbsentReason

CodeableConcept dataAbsentReason

Describes why the family member's history is not available.

date

DateTimeType date

The date (and possibly time) when the family member history was recorded or last updated.

deceased

Type deceased

Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

estimatedAge

BooleanType estimatedAge

If true, indicates that the age value specified is an estimated value.

identifier

List<Identifier> identifier

Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

instantiatesCanonical

List<CanonicalType> instantiatesCanonical

The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

instantiatesUri

List<UriType> instantiatesUri

The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

name

StringType name

This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".

note

List<Annotation> note

This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.

patient

Reference patient

The person who this history concerns.

patientTarget

Patient patientTarget

The actual object that is the target of the reference (The person who this history concerns.)

reasonCode

List<CodeableConcept> reasonCode

Describes why the family member history occurred in coded or textual form.

reasonReference

List<Reference> reasonReference

Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.

reasonReferenceTarget

List<Resource> reasonReferenceTarget

The actual objects that are the target of the reference (Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.)

relationship

CodeableConcept relationship

The type of relationship this person has to the patient (father, mother, brother etc.).

sex

CodeableConcept sex

The birth sex of the family member.

status

Enumeration<FamilyMemberHistory.FamilyHistoryStatus> status

A code specifying the status of the record of the family history of a specific family member.

Class org.hl7.fhir.r4.model.FamilyMemberHistory.FamilyHistoryStatusEnumFactory

class FamilyHistoryStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.FamilyMemberHistory.FamilyMemberHistoryConditionComponent

class FamilyMemberHistoryConditionComponent extends BackboneElement implements Serializable

serialVersionUID:

1230182301L

Serialized Fields

code

CodeableConcept code

The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system.

contributedToDeath

BooleanType contributedToDeath

This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.

note

List<Annotation> note

An area where general notes can be placed about this specific condition.

onset

Type onset

Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.

outcome

CodeableConcept outcome

Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation.

Class org.hl7.fhir.r4.model.Flag

class Flag extends DomainResource implements Serializable

serialVersionUID:

163791439L

Serialized Fields

author

Reference author

The person, organization or device that created the flag.

authorTarget

Resource authorTarget

The actual object that is the target of the reference (The person, organization or device that created the flag.)

category

List<CodeableConcept> category

Allows a flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context.

code

CodeableConcept code

The coded value or textual component of the flag to display to the user.

encounter

Reference encounter

This alert is only relevant during the encounter.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (This alert is only relevant during the encounter.)

identifier

List<Identifier> identifier

Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

period

Period period

The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified.

status

Enumeration<Flag.FlagStatus> status

Supports basic workflow.

subject

Reference subject

The patient, location, group, organization, or practitioner etc. this is about record this flag is associated with.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (The patient, location, group, organization, or practitioner etc. this is about record this flag is associated with.)

Class org.hl7.fhir.r4.model.Flag.FlagStatusEnumFactory

class FlagStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Goal

class Goal extends DomainResource implements Serializable

serialVersionUID:

-1366854797L

Serialized Fields

achievementStatus

CodeableConcept achievementStatus

Describes the progression, or lack thereof, towards the goal against the target.

addresses

List<Reference> addresses

The identified conditions and other health record elements that are intended to be addressed by the goal.

addressesTarget

List<Resource> addressesTarget

The actual objects that are the target of the reference (The identified conditions and other health record elements that are intended to be addressed by the goal.)

category

List<CodeableConcept> category

Indicates a category the goal falls within.

description

CodeableConcept description

Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".

expressedBy

Reference expressedBy

Indicates whose goal this is - patient goal, practitioner goal, etc.

expressedByTarget

Resource expressedByTarget

The actual object that is the target of the reference (Indicates whose goal this is - patient goal, practitioner goal, etc.)

identifier

List<Identifier> identifier

Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

lifecycleStatus

Enumeration<Goal.GoalLifecycleStatus> lifecycleStatus

The state of the goal throughout its lifecycle.

note

List<Annotation> note

Any comments related to the goal.

outcomeCode

List<CodeableConcept> outcomeCode

Identifies the change (or lack of change) at the point when the status of the goal is assessed.

outcomeReference

List<Reference> outcomeReference

Details of what's changed (or not changed).

outcomeReferenceTarget

List<Observation> outcomeReferenceTarget

The actual objects that are the target of the reference (Details of what's changed (or not changed).)

priority

CodeableConcept priority

Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.

start

Type start

The date or event after which the goal should begin being pursued.

statusDate

DateType statusDate

Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.

statusReason

StringType statusReason

Captures the reason for the current status.

subject

Reference subject

Identifies the patient, group or organization for whom the goal is being established.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (Identifies the patient, group or organization for whom the goal is being established.)

target

List<Goal.GoalTargetComponent> target

Indicates what should be done by when.

Class org.hl7.fhir.r4.model.Goal.GoalLifecycleStatusEnumFactory

class GoalLifecycleStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Goal.GoalTargetComponent

class GoalTargetComponent extends BackboneElement implements Serializable

serialVersionUID:

-585108934L

Serialized Fields

detail

Type detail

The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

due

Type due

Indicates either the date or the duration after start by which the goal should be met.

measure

CodeableConcept measure

The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.

Class org.hl7.fhir.r4.model.GraphDefinition

class GraphDefinition extends MetadataResource implements Serializable

serialVersionUID:

1529157887L

Serialized Fields

link

List<GraphDefinition.GraphDefinitionLinkComponent> link

Links this graph makes rules about.

profile

CanonicalType profile

The profile that describes the use of the base resource.

purpose

MarkdownType purpose

Explanation of why this graph definition is needed and why it has been designed as it has.

start

CodeType start

The type of FHIR resource at which instances of this graph start.

Class org.hl7.fhir.r4.model.GraphDefinition.CompartmentCodeEnumFactory

class CompartmentCodeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.GraphDefinition.GraphCompartmentRuleEnumFactory

class GraphCompartmentRuleEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.GraphDefinition.GraphCompartmentUseEnumFactory

class GraphCompartmentUseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.GraphDefinition.GraphDefinitionLinkComponent

class GraphDefinitionLinkComponent extends BackboneElement implements Serializable

serialVersionUID:

-593733346L

Serialized Fields

description

StringType description

Information about why this link is of interest in this graph definition.

max

StringType max

Maximum occurrences for this link.

min

IntegerType min

Minimum occurrences for this link.

path

StringType path

A FHIR expression that identifies one of FHIR References to other resources.

sliceName

StringType sliceName

Which slice (if profiled).

target

List<GraphDefinition.GraphDefinitionLinkTargetComponent> target

Potential target for the link.

Class org.hl7.fhir.r4.model.GraphDefinition.GraphDefinitionLinkTargetCompartmentComponent

class GraphDefinitionLinkTargetCompartmentComponent extends BackboneElement implements Serializable

serialVersionUID:

1023364175L

Serialized Fields

code

Enumeration<GraphDefinition.CompartmentCode> code

Identifies the compartment.

description

StringType description

Documentation for FHIRPath expression.

expression

StringType expression

Custom rule, as a FHIRPath expression.

rule

Enumeration<GraphDefinition.GraphCompartmentRule> rule

identical | matching | different | no-rule | custom.

use

Enumeration<GraphDefinition.GraphCompartmentUse> use

Defines how the compartment rule is used - whether it it is used to test whether resources are subject to the rule, or whether it is a rule that must be followed.

Class org.hl7.fhir.r4.model.GraphDefinition.GraphDefinitionLinkTargetComponent

class GraphDefinitionLinkTargetComponent extends BackboneElement implements Serializable

serialVersionUID:

-35248998L

Serialized Fields

compartment

List<GraphDefinition.GraphDefinitionLinkTargetCompartmentComponent> compartment

Compartment Consistency Rules.

link

List<GraphDefinition.GraphDefinitionLinkComponent> link

Additional links from target resource.

params

StringType params

A set of parameters to look up.

profile

CanonicalType profile

Profile for the target resource.

type

CodeType type

Type of resource this link refers to.

Class org.hl7.fhir.r4.model.Group

class Group extends DomainResource implements Serializable

serialVersionUID:

-550945963L

Serialized Fields

active

BooleanType active

Indicates whether the record for the group is available for use or is merely being retained for historical purposes.

actual

BooleanType actual

If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.

characteristic

List<Group.GroupCharacteristicComponent> characteristic

Identifies traits whose presence r absence is shared by members of the group.

code

CodeableConcept code

Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc.

identifier

List<Identifier> identifier

A unique business identifier for this group.

managingEntity

Reference managingEntity

Entity responsible for defining and maintaining Group characteristics and/or registered members.

managingEntityTarget

Resource managingEntityTarget

The actual object that is the target of the reference (Entity responsible for defining and maintaining Group characteristics and/or registered members.)

member

List<Group.GroupMemberComponent> member

Identifies the resource instances that are members of the group.

name

StringType name

A label assigned to the group for human identification and communication.

quantity

UnsignedIntType quantity

A count of the number of resource instances that are part of the group.

type

Enumeration<Group.GroupType> type

Identifies the broad classification of the kind of resources the group includes.

Class org.hl7.fhir.r4.model.Group.GroupCharacteristicComponent

class GroupCharacteristicComponent extends BackboneElement implements Serializable

serialVersionUID:

-1000688967L

Serialized Fields

code

CodeableConcept code

A code that identifies the kind of trait being asserted.

exclude

BooleanType exclude

If true, indicates the characteristic is one that is NOT held by members of the group.

period

Period period

The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.

value

Type value

The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

Class org.hl7.fhir.r4.model.Group.GroupMemberComponent

class GroupMemberComponent extends BackboneElement implements Serializable

serialVersionUID:

-333869055L

Serialized Fields

entity

Reference entity

A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same.

entityTarget

Resource entityTarget

The actual object that is the target of the reference (A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same.)

inactive

BooleanType inactive

A flag to indicate that the member is no longer in the group, but previously may have been a member.

period

Period period

The period that the member was in the group, if known.

Class org.hl7.fhir.r4.model.Group.GroupTypeEnumFactory

class GroupTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.GuidanceResponse

class GuidanceResponse extends DomainResource implements Serializable

serialVersionUID:

-760182193L

Serialized Fields

dataRequirement

List<DataRequirement> dataRequirement

If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.

encounter

Reference encounter

The encounter during which this response was created or to which the creation of this record is tightly associated.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (The encounter during which this response was created or to which the creation of this record is tightly associated.)

evaluationMessage

List<Reference> evaluationMessage

Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.

evaluationMessageTarget

List<OperationOutcome> evaluationMessageTarget

The actual objects that are the target of the reference (Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.)

identifier

List<Identifier> identifier

Allows a service to provide unique, business identifiers for the response.

module

Type module

An identifier, CodeableConcept or canonical reference to the guidance that was requested.

note

List<Annotation> note

Provides a mechanism to communicate additional information about the response.

occurrenceDateTime

DateTimeType occurrenceDateTime

Indicates when the guidance response was processed.

outputParameters

Reference outputParameters

The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element.

outputParametersTarget

Parameters outputParametersTarget

The actual object that is the target of the reference (The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element.)

performer

Reference performer

Provides a reference to the device that performed the guidance.

performerTarget

Device performerTarget

The actual object that is the target of the reference (Provides a reference to the device that performed the guidance.)

reasonCode

List<CodeableConcept> reasonCode

Describes the reason for the guidance response in coded or textual form.

reasonReference

List<Reference> reasonReference

Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.

reasonReferenceTarget

List<Resource> reasonReferenceTarget

The actual objects that are the target of the reference (Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.)

requestIdentifier

Identifier requestIdentifier

The identifier of the request associated with this response. If an identifier was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario.

result

Reference result

The actions, if any, produced by the evaluation of the artifact.

resultTarget

Resource resultTarget

The actual object that is the target of the reference (The actions, if any, produced by the evaluation of the artifact.)

status

Enumeration<GuidanceResponse.GuidanceResponseStatus> status

The status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information.

subject

Reference subject

The patient for which the request was processed.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (The patient for which the request was processed.)

Class org.hl7.fhir.r4.model.GuidanceResponse.GuidanceResponseStatusEnumFactory

class GuidanceResponseStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.HealthcareService

class HealthcareService extends DomainResource implements Serializable

serialVersionUID:

-2002412666L

Serialized Fields

active

BooleanType active

This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.

appointmentRequired

BooleanType appointmentRequired

Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.

availabilityExceptions

StringType availabilityExceptions

A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.

availableTime

List<HealthcareService.HealthcareServiceAvailableTimeComponent> availableTime

A collection of times that the Service Site is available.

category

List<CodeableConcept> category

Identifies the broad category of service being performed or delivered.

characteristic

List<CodeableConcept> characteristic

Collection of characteristics (attributes).

comment

StringType comment

Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.

communication

List<CodeableConcept> communication

Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used.

coverageArea

List<Reference> coverageArea

The location(s) that this service is available to (not where the service is provided).

coverageAreaTarget

List<Location> coverageAreaTarget

The actual objects that are the target of the reference (The location(s) that this service is available to (not where the service is provided).)

eligibility

List<HealthcareService.HealthcareServiceEligibilityComponent> eligibility

Does this service have specific eligibility requirements that need to be met in order to use the service?

endpoint

List<Reference> endpoint

Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.

endpointTarget

List<Endpoint> endpointTarget

The actual objects that are the target of the reference (Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.)

extraDetails

MarkdownType extraDetails

Extra details about the service that can't be placed in the other fields.

identifier

List<Identifier> identifier

External identifiers for this item.

location

List<Reference> location

The location(s) where this healthcare service may be provided.

locationTarget

List<Location> locationTarget

The actual objects that are the target of the reference (The location(s) where this healthcare service may be provided.)

name

StringType name

Further description of the service as it would be presented to a consumer while searching.

notAvailable

List<HealthcareService.HealthcareServiceNotAvailableComponent> notAvailable

The HealthcareService is not available during this period of time due to the provided reason.

photo

Attachment photo

If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.

program

List<CodeableConcept> program

Programs that this service is applicable to.

providedBy

Reference providedBy

The organization that provides this healthcare service.

providedByTarget

Organization providedByTarget

The actual object that is the target of the reference (The organization that provides this healthcare service.)

referralMethod

List<CodeableConcept> referralMethod

Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.

serviceProvisionCode

List<CodeableConcept> serviceProvisionCode

The code(s) that detail the conditions under which the healthcare service is available/offered.

specialty

List<CodeableConcept> specialty

Collection of specialties handled by the service site. This is more of a medical term.

telecom

List<ContactPoint> telecom

List of contacts related to this specific healthcare service.

type

List<CodeableConcept> type

The specific type of service that may be delivered or performed.

Class org.hl7.fhir.r4.model.HealthcareService.DaysOfWeekEnumFactory

class DaysOfWeekEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.HealthcareService.HealthcareServiceAvailableTimeComponent

class HealthcareServiceAvailableTimeComponent extends BackboneElement implements Serializable

serialVersionUID:

-2139510127L

Serialized Fields

allDay

BooleanType allDay

Is this always available? (hence times are irrelevant) e.g. 24 hour service.

availableEndTime

TimeType availableEndTime

The closing time of day. Note: If the AllDay flag is set, then this time is ignored.

availableStartTime

TimeType availableStartTime

The opening time of day. Note: If the AllDay flag is set, then this time is ignored.

daysOfWeek

List<Enumeration<HealthcareService.DaysOfWeek>> daysOfWeek

Indicates which days of the week are available between the start and end Times.

Class org.hl7.fhir.r4.model.HealthcareService.HealthcareServiceEligibilityComponent

class HealthcareServiceEligibilityComponent extends BackboneElement implements Serializable

serialVersionUID:

1078065348L

Serialized Fields

code

CodeableConcept code

Coded value for the eligibility.

comment

MarkdownType comment

Describes the eligibility conditions for the service.

Class org.hl7.fhir.r4.model.HealthcareService.HealthcareServiceNotAvailableComponent

class HealthcareServiceNotAvailableComponent extends BackboneElement implements Serializable

serialVersionUID:

310849929L

Serialized Fields

description

StringType description

The reason that can be presented to the user as to why this time is not available.

during

Period during

Service is not available (seasonally or for a public holiday) from this date.

Class org.hl7.fhir.r4.model.HumanName

class HumanName extends Type implements Serializable

serialVersionUID:

-507469160L

Serialized Fields

family

StringType family

The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

given

List<StringType> given

Given name.

period

Period period

Indicates the period of time when this name was valid for the named person.

prefix

List<StringType> prefix

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

suffix

List<StringType> suffix

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

text

StringType text

Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

use

Enumeration<HumanName.NameUse> use

Identifies the purpose for this name.

Class org.hl7.fhir.r4.model.HumanName.NameUseEnumFactory

class NameUseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Identifier

class Identifier extends Type implements Serializable

serialVersionUID:

-478840981L

Serialized Fields

assigner

Reference assigner

Organization that issued/manages the identifier.

assignerTarget

Organization assignerTarget

The actual object that is the target of the reference (Organization that issued/manages the identifier.)

period

Period period

Time period during which identifier is/was valid for use.

system

UriType system

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

type

CodeableConcept type

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

use

Enumeration<Identifier.IdentifierUse> use

The purpose of this identifier.

value

StringType value

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Class org.hl7.fhir.r4.model.Identifier.IdentifierUseEnumFactory

class IdentifierUseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.IdType

class IdType extends UriType implements Externalizable

serialVersionUID:

2L

Serialization Methods

readExternal

public void readExternal(ObjectInput theIn)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput theOut)
                   throws IOException

Throws:

IOException

Class org.hl7.fhir.r4.model.ImagingStudy

class ImagingStudy extends DomainResource implements Serializable

serialVersionUID:

-647973361L

Serialized Fields

basedOn

List<Reference> basedOn

A list of the diagnostic requests that resulted in this imaging study being performed.

basedOnTarget

List<Resource> basedOnTarget

The actual objects that are the target of the reference (A list of the diagnostic requests that resulted in this imaging study being performed.)

description

StringType description

The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.

encounter

Reference encounter

The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made.)

endpoint

List<Reference> endpoint

The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.

endpointTarget

List<Endpoint> endpointTarget

The actual objects that are the target of the reference (The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.)

identifier

List<Identifier> identifier

Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.

interpreter

List<Reference> interpreter

Who read the study and interpreted the images or other content.

interpreterTarget

List<Resource> interpreterTarget

The actual objects that are the target of the reference (Who read the study and interpreted the images or other content.)

location

Reference location

The principal physical location where the ImagingStudy was performed.

locationTarget

Location locationTarget

The actual object that is the target of the reference (The principal physical location where the ImagingStudy was performed.)

modality

List<Coding> modality

A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).

note

List<Annotation> note

Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.

numberOfInstances

UnsignedIntType numberOfInstances

Number of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.

numberOfSeries

UnsignedIntType numberOfSeries

Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.

procedureCode

List<CodeableConcept> procedureCode

The code for the performed procedure type.

procedureReference

Reference procedureReference

The procedure which this ImagingStudy was part of.

procedureReferenceTarget

Procedure procedureReferenceTarget

The actual object that is the target of the reference (The procedure which this ImagingStudy was part of.)

reasonCode

List<CodeableConcept> reasonCode

Description of clinical condition indicating why the ImagingStudy was requested.

reasonReference

List<Reference> reasonReference

Indicates another resource whose existence justifies this Study.

reasonReferenceTarget

List<Resource> reasonReferenceTarget

The actual objects that are the target of the reference (Indicates another resource whose existence justifies this Study.)

referrer

Reference referrer

The requesting/referring physician.

referrerTarget

Resource referrerTarget

The actual object that is the target of the reference (The requesting/referring physician.)

series

List<ImagingStudy.ImagingStudySeriesComponent> series

Each study has one or more series of images or other content.

started

DateTimeType started

Date and time the study started.

status

Enumeration<ImagingStudy.ImagingStudyStatus> status

The current state of the ImagingStudy.

subject

Reference subject

The subject, typically a patient, of the imaging study.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (The subject, typically a patient, of the imaging study.)

Class org.hl7.fhir.r4.model.ImagingStudy.ImagingStudySeriesComponent

class ImagingStudySeriesComponent extends BackboneElement implements Serializable

serialVersionUID:

-11423429L

Serialized Fields

bodySite

Coding bodySite

The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality.

description

StringType description

A description of the series.

endpoint

List<Reference> endpoint

The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.connectionType.

endpointTarget

List<Endpoint> endpointTarget

The actual objects that are the target of the reference (The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.connectionType.)

instance

List<ImagingStudy.ImagingStudySeriesInstanceComponent> instance

A single SOP instance within the series, e.g. an image, or presentation state.

laterality

Coding laterality

The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite.

modality

Coding modality

The modality of this series sequence.

number

UnsignedIntType number

The numeric identifier of this series in the study.

numberOfInstances

UnsignedIntType numberOfInstances

Number of SOP Instances in the Study. The value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.

performer

List<ImagingStudy.ImagingStudySeriesPerformerComponent> performer

Indicates who or what performed the series and how they were involved.

specimen

List<Reference> specimen

The specimen imaged, e.g., for whole slide imaging of a biopsy.

specimenTarget

List<Specimen> specimenTarget

The actual objects that are the target of the reference (The specimen imaged, e.g., for whole slide imaging of a biopsy.)

started

DateTimeType started

The date and time the series was started.

uid

IdType uid

The DICOM Series Instance UID for the series.

Class org.hl7.fhir.r4.model.ImagingStudy.ImagingStudySeriesInstanceComponent

class ImagingStudySeriesInstanceComponent extends BackboneElement implements Serializable

serialVersionUID:

-888152445L

Serialized Fields

number

UnsignedIntType number

The number of instance in the series.

sopClass

Coding sopClass

DICOM instance type.

title

StringType title

The description of the instance.

uid

IdType uid

The DICOM SOP Instance UID for this image or other DICOM content.

Class org.hl7.fhir.r4.model.ImagingStudy.ImagingStudySeriesPerformerComponent

class ImagingStudySeriesPerformerComponent extends BackboneElement implements Serializable

serialVersionUID:

1424001049L

Serialized Fields

actor

Reference actor

Indicates who or what performed the series.

actorTarget

Resource actorTarget

The actual object that is the target of the reference (Indicates who or what performed the series.)

function

CodeableConcept function

Distinguishes the type of involvement of the performer in the series.

Class org.hl7.fhir.r4.model.ImagingStudy.ImagingStudyStatusEnumFactory

class ImagingStudyStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Immunization

class Immunization extends DomainResource implements Serializable

serialVersionUID:

1946730839L

Serialized Fields

doseQuantity

Quantity doseQuantity

The quantity of vaccine product that was administered.

education

List<Immunization.ImmunizationEducationComponent> education

Educational material presented to the patient (or guardian) at the time of vaccine administration.

encounter

Reference encounter

The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (The visit or admission or other contact between patient and health care provider the immunization was performed as part of.)

expirationDate

DateType expirationDate

Date vaccine batch expires.

fundingSource

CodeableConcept fundingSource

Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).

identifier

List<Identifier> identifier

A unique identifier assigned to this immunization record.

isSubpotent

BooleanType isSubpotent

Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.

location

Reference location

The service delivery location where the vaccine administration occurred.

locationTarget

Location locationTarget

The actual object that is the target of the reference (The service delivery location where the vaccine administration occurred.)

lotNumber

StringType lotNumber

Lot number of the vaccine product.

manufacturer

Reference manufacturer

Name of vaccine manufacturer.

manufacturerTarget

Organization manufacturerTarget

The actual object that is the target of the reference (Name of vaccine manufacturer.)

note

List<Annotation> note

Extra information about the immunization that is not conveyed by the other attributes.

occurrence

Type occurrence

Date vaccine administered or was to be administered.

patient

Reference patient

The patient who either received or did not receive the immunization.

patientTarget

Patient patientTarget

The actual object that is the target of the reference (The patient who either received or did not receive the immunization.)

performer

List<Immunization.ImmunizationPerformerComponent> performer

Indicates who performed the immunization event.

primarySource

BooleanType primarySource

An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.

programEligibility

List<CodeableConcept> programEligibility

Indicates a patient's eligibility for a funding program.

protocolApplied

List<Immunization.ImmunizationProtocolAppliedComponent> protocolApplied

The protocol (set of recommendations) being followed by the provider who administered the dose.

reaction

List<Immunization.ImmunizationReactionComponent> reaction

Categorical data indicating that an adverse event is associated in time to an immunization.

reasonCode

List<CodeableConcept> reasonCode

Reasons why the vaccine was administered.

reasonReference

List<Reference> reasonReference

Condition, Observation or DiagnosticReport that supports why the immunization was administered.

reasonReferenceTarget

List<Resource> reasonReferenceTarget

The actual objects that are the target of the reference (Condition, Observation or DiagnosticReport that supports why the immunization was administered.)

recorded

DateTimeType recorded

The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.

reportOrigin

CodeableConcept reportOrigin

The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.

route

CodeableConcept route

The path by which the vaccine product is taken into the body.

site

CodeableConcept site

Body site where vaccine was administered.

status

Enumeration<Immunization.ImmunizationStatus> status

Indicates the current status of the immunization event.

statusReason

CodeableConcept statusReason

Indicates the reason the immunization event was not performed.

subpotentReason

List<CodeableConcept> subpotentReason

Reason why a dose is considered to be subpotent.

vaccineCode

CodeableConcept vaccineCode

Vaccine that was administered or was to be administered.

Class org.hl7.fhir.r4.model.Immunization.ImmunizationEducationComponent

class ImmunizationEducationComponent extends BackboneElement implements Serializable

serialVersionUID:

-1277654827L

Serialized Fields

documentType

StringType documentType

Identifier of the material presented to the patient.

presentationDate

DateTimeType presentationDate

Date the educational material was given to the patient.

publicationDate

DateTimeType publicationDate

Date the educational material was published.

reference

UriType reference

Reference pointer to the educational material given to the patient if the information was on line.

Class org.hl7.fhir.r4.model.Immunization.ImmunizationPerformerComponent

class ImmunizationPerformerComponent extends BackboneElement implements Serializable

serialVersionUID:

1424001049L

Serialized Fields

actor

Reference actor

The practitioner or organization who performed the action.

actorTarget

Resource actorTarget

The actual object that is the target of the reference (The practitioner or organization who performed the action.)

function

CodeableConcept function

Describes the type of performance (e.g. ordering provider, administering provider, etc.).

Class org.hl7.fhir.r4.model.Immunization.ImmunizationProtocolAppliedComponent

class ImmunizationProtocolAppliedComponent extends BackboneElement implements Serializable

serialVersionUID:

-1022717242L

Serialized Fields

authority

Reference authority

Indicates the authority who published the protocol (e.g. ACIP) that is being followed.

authorityTarget

Organization authorityTarget

The actual object that is the target of the reference (Indicates the authority who published the protocol (e.g. ACIP) that is being followed.)

doseNumber

Type doseNumber

Nominal position in a series.

series

StringType series

One possible path to achieve presumed immunity against a disease - within the context of an authority.

seriesDoses

Type seriesDoses

The recommended number of doses to achieve immunity.

targetDisease

List<CodeableConcept> targetDisease

The vaccine preventable disease the dose is being administered against.

Class org.hl7.fhir.r4.model.Immunization.ImmunizationReactionComponent

class ImmunizationReactionComponent extends BackboneElement implements Serializable

serialVersionUID:

-1297668556L

Serialized Fields

date

DateTimeType date

Date of reaction to the immunization.

detail

Reference detail

Details of the reaction.

detailTarget

Observation detailTarget

The actual object that is the target of the reference (Details of the reaction.)

reported

BooleanType reported

Self-reported indicator.

Class org.hl7.fhir.r4.model.Immunization.ImmunizationStatusEnumFactory

class ImmunizationStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ImmunizationEvaluation

class ImmunizationEvaluation extends DomainResource implements Serializable

serialVersionUID:

1248741226L

Serialized Fields

authority

Reference authority

Indicates the authority who published the protocol (e.g. ACIP).

authorityTarget

Organization authorityTarget

The actual object that is the target of the reference (Indicates the authority who published the protocol (e.g. ACIP).)

date

DateTimeType date

The date the evaluation of the vaccine administration event was performed.

description

StringType description

Additional information about the evaluation.

doseNumber

Type doseNumber

Nominal position in a series.

doseStatus

CodeableConcept doseStatus

Indicates if the dose is valid or not valid with respect to the published recommendations.

doseStatusReason

List<CodeableConcept> doseStatusReason

Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.

identifier

List<Identifier> identifier

A unique identifier assigned to this immunization evaluation record.

immunizationEvent

Reference immunizationEvent

The vaccine administration event being evaluated.

immunizationEventTarget

Immunization immunizationEventTarget

The actual object that is the target of the reference (The vaccine administration event being evaluated.)

patient

Reference patient

The individual for whom the evaluation is being done.

patientTarget

Patient patientTarget

The actual object that is the target of the reference (The individual for whom the evaluation is being done.)

series

StringType series

One possible path to achieve presumed immunity against a disease - within the context of an authority.

seriesDoses

Type seriesDoses

The recommended number of doses to achieve immunity.

status

Enumeration<ImmunizationEvaluation.ImmunizationEvaluationStatus> status

Indicates the current status of the evaluation of the vaccination administration event.

targetDisease

CodeableConcept targetDisease

The vaccine preventable disease the dose is being evaluated against.

Class org.hl7.fhir.r4.model.ImmunizationEvaluation.ImmunizationEvaluationStatusEnumFactory

class ImmunizationEvaluationStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ImmunizationRecommendation

class ImmunizationRecommendation extends DomainResource implements Serializable

serialVersionUID:

-2031711761L

Serialized Fields

authority

Reference authority

Indicates the authority who published the protocol (e.g. ACIP).

authorityTarget

Organization authorityTarget

The actual object that is the target of the reference (Indicates the authority who published the protocol (e.g. ACIP).)

date

DateTimeType date

The date the immunization recommendation(s) were created.

identifier

List<Identifier> identifier

A unique identifier assigned to this particular recommendation record.

patient

Reference patient

The patient the recommendation(s) are for.

patientTarget

Patient patientTarget

The actual object that is the target of the reference (The patient the recommendation(s) are for.)

recommendation

List<ImmunizationRecommendation.ImmunizationRecommendationRecommendationComponent> recommendation

Vaccine administration recommendations.

Class org.hl7.fhir.r4.model.ImmunizationRecommendation.ImmunizationRecommendationRecommendationComponent

class ImmunizationRecommendationRecommendationComponent extends BackboneElement implements Serializable

serialVersionUID:

-667399405L

Serialized Fields

contraindicatedVaccineCode

List<CodeableConcept> contraindicatedVaccineCode

Vaccine(s) which should not be used to fulfill the recommendation.

dateCriterion

List<ImmunizationRecommendation.ImmunizationRecommendationRecommendationDateCriterionComponent> dateCriterion

Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.

description

StringType description

Contains the description about the protocol under which the vaccine was administered.

doseNumber

Type doseNumber

Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose).

forecastReason

List<CodeableConcept> forecastReason

The reason for the assigned forecast status.

forecastStatus

CodeableConcept forecastStatus

Indicates the patient status with respect to the path to immunity for the target disease.

series

StringType series

One possible path to achieve presumed immunity against a disease - within the context of an authority.

seriesDoses

Type seriesDoses

The recommended number of doses to achieve immunity.

supportingImmunization

List<Reference> supportingImmunization

Immunization event history and/or evaluation that supports the status and recommendation.

supportingImmunizationTarget

List<Resource> supportingImmunizationTarget

The actual objects that are the target of the reference (Immunization event history and/or evaluation that supports the status and recommendation.)

supportingPatientInformation

List<Reference> supportingPatientInformation

Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.

supportingPatientInformationTarget

List<Resource> supportingPatientInformationTarget

The actual objects that are the target of the reference (Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.)

targetDisease

CodeableConcept targetDisease

The targeted disease for the recommendation.

vaccineCode

List<CodeableConcept> vaccineCode

Vaccine(s) or vaccine group that pertain to the recommendation.

Class org.hl7.fhir.r4.model.ImmunizationRecommendation.ImmunizationRecommendationRecommendationDateCriterionComponent

class ImmunizationRecommendationRecommendationDateCriterionComponent extends BackboneElement implements Serializable

serialVersionUID:

1036994566L

Serialized Fields

code

CodeableConcept code

Date classification of recommendation. For example, earliest date to give, latest date to give, etc.

value

DateTimeType value

The date whose meaning is specified by dateCriterion.code.

Class org.hl7.fhir.r4.model.ImplementationGuide

class ImplementationGuide extends MetadataResource implements Serializable

serialVersionUID:

415193005L

Serialized Fields

copyright

MarkdownType copyright

A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide.

definition

ImplementationGuide.ImplementationGuideDefinitionComponent definition

The information needed by an IG publisher tool to publish the whole implementation guide.

dependsOn

List<ImplementationGuide.ImplementationGuideDependsOnComponent> dependsOn

Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.

fhirVersion

List<Enumeration<Enumerations.FHIRVersion>> fhirVersion

The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.1. for this version.

global

List<ImplementationGuide.ImplementationGuideGlobalComponent> global

A set of profiles that all resources covered by this implementation guide must conform to.

license

Enumeration<ImplementationGuide.SPDXLicense> license

The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'.

manifest

ImplementationGuide.ImplementationGuideManifestComponent manifest

Information about an assembled implementation guide, created by the publication tooling.

packageId

IdType packageId

The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care.

Class org.hl7.fhir.r4.model.ImplementationGuide.GuidePageGenerationEnumFactory

class GuidePageGenerationEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ImplementationGuide.GuideParameterCodeEnumFactory

class GuideParameterCodeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ImplementationGuide.ImplementationGuideDefinitionComponent

class ImplementationGuideDefinitionComponent extends BackboneElement implements Serializable

serialVersionUID:

179051968L

Serialized Fields

grouping

List<ImplementationGuide.ImplementationGuideDefinitionGroupingComponent> grouping

A logical group of resources. Logical groups can be used when building pages.

page

ImplementationGuide.ImplementationGuideDefinitionPageComponent page

A page / section in the implementation guide. The root page is the implementation guide home page.

parameter

List<ImplementationGuide.ImplementationGuideDefinitionParameterComponent> parameter

Defines how IG is built by tools.

resource

List<ImplementationGuide.ImplementationGuideDefinitionResourceComponent> resource

A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.

template

List<ImplementationGuide.ImplementationGuideDefinitionTemplateComponent> template

A template for building resources.

Class org.hl7.fhir.r4.model.ImplementationGuide.ImplementationGuideDefinitionGroupingComponent

class ImplementationGuideDefinitionGroupingComponent extends BackboneElement implements Serializable

serialVersionUID:

-1105523499L

Serialized Fields

description

StringType description

Human readable text describing the package.

name

StringType name

The human-readable title to display for the package of resources when rendering the implementation guide.

Class org.hl7.fhir.r4.model.ImplementationGuide.ImplementationGuideDefinitionPageComponent

class ImplementationGuideDefinitionPageComponent extends BackboneElement implements Serializable

serialVersionUID:

-365655658L

Serialized Fields

generation

Enumeration<ImplementationGuide.GuidePageGeneration> generation

A code that indicates how the page is generated.

name

Type name

The source address for the page.

page

List<ImplementationGuide.ImplementationGuideDefinitionPageComponent> page

Nested Pages/Sections under this page.

title

StringType title

A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc.

Class org.hl7.fhir.r4.model.ImplementationGuide.ImplementationGuideDefinitionParameterComponent

class ImplementationGuideDefinitionParameterComponent extends BackboneElement implements Serializable

serialVersionUID:

1188999138L

Serialized Fields

code

StringType code

apply | path-resource | path-pages | path-tx-cache | expansion-parameter | rule-broken-links | generate-xml | generate-json | generate-turtle | html-template.

value

StringType value

Value for named type.

Class org.hl7.fhir.r4.model.ImplementationGuide.ImplementationGuideDefinitionResourceComponent

class ImplementationGuideDefinitionResourceComponent extends BackboneElement implements Serializable

serialVersionUID:

1840689093L

Serialized Fields

description

StringType description

A description of the reason that a resource has been included in the implementation guide.

example

Type example

If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.

fhirVersion

List<Enumeration<Enumerations.FHIRVersion>> fhirVersion

Indicates the FHIR Version(s) this artifact is intended to apply to. If no versions are specified, the resource is assumed to apply to all the versions stated in ImplementationGuide.fhirVersion.

groupingId

IdType groupingId

Reference to the id of the grouping this resource appears in.

name

StringType name

A human assigned name for the resource. All resources SHOULD have a name, but the name may be extracted from the resource (e.g. ValueSet.name).

reference

Reference reference

Where this resource is found.

referenceTarget

Resource referenceTarget

The actual object that is the target of the reference (Where this resource is found.)

Class org.hl7.fhir.r4.model.ImplementationGuide.ImplementationGuideDefinitionTemplateComponent

class ImplementationGuideDefinitionTemplateComponent extends BackboneElement implements Serializable

serialVersionUID:

923832457L

Serialized Fields

code

CodeType code

Type of template specified.

scope

StringType scope

The scope in which the template applies.

source

StringType source

The source location for the template.

Class org.hl7.fhir.r4.model.ImplementationGuide.ImplementationGuideDependsOnComponent

class ImplementationGuideDependsOnComponent extends BackboneElement implements Serializable

serialVersionUID:

-215808797L

Serialized Fields

packageId

IdType packageId

The NPM package name for the Implementation Guide that this IG depends on.

uri

CanonicalType uri

A canonical reference to the Implementation guide for the dependency.

version

StringType version

The version of the IG that is depended on, when the correct version is required to understand the IG correctly.

Class org.hl7.fhir.r4.model.ImplementationGuide.ImplementationGuideGlobalComponent

class ImplementationGuideGlobalComponent extends BackboneElement implements Serializable

serialVersionUID:

33894666L

Serialized Fields

profile

CanonicalType profile

A reference to the profile that all instances must conform to.

type

CodeType type

The type of resource that all instances must conform to.

Class org.hl7.fhir.r4.model.ImplementationGuide.ImplementationGuideManifestComponent

class ImplementationGuideManifestComponent extends BackboneElement implements Serializable

serialVersionUID:

1881327712L

Serialized Fields

image

List<StringType> image

Indicates a relative path to an image that exists within the IG.

other

List<StringType> other

Indicates the relative path of an additional non-page, non-image file that is part of the IG - e.g. zip, jar and similar files that could be the target of a hyperlink in a derived IG.

page

List<ImplementationGuide.ManifestPageComponent> page

Information about a page within the IG.

rendering

UrlType rendering

A pointer to official web page, PDF or other rendering of the implementation guide.

resource

List<ImplementationGuide.ManifestResourceComponent> resource

A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.

Class org.hl7.fhir.r4.model.ImplementationGuide.ManifestPageComponent

class ManifestPageComponent extends BackboneElement implements Serializable

serialVersionUID:

1920576611L

Serialized Fields

anchor

List<StringType> anchor

The name of an anchor available on the page.

name

StringType name

Relative path to the page.

title

StringType title

Label for the page intended for human display.

Class org.hl7.fhir.r4.model.ImplementationGuide.ManifestResourceComponent

class ManifestResourceComponent extends BackboneElement implements Serializable

serialVersionUID:

1150095716L

Serialized Fields

example

Type example

If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.

reference

Reference reference

Where this resource is found.

referenceTarget

Resource referenceTarget

The actual object that is the target of the reference (Where this resource is found.)

relativePath

UrlType relativePath

The relative path for primary page for this resource within the IG.

Class org.hl7.fhir.r4.model.ImplementationGuide.SPDXLicenseEnumFactory

class SPDXLicenseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.InstantType

class InstantType extends BaseDateTimeType implements Externalizable

serialVersionUID:

3L

Serialization Methods

readExternal

public void readExternal(ObjectInput theIn)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput theOut)
                   throws IOException

Throws:

IOException

Class org.hl7.fhir.r4.model.InsurancePlan

class InsurancePlan extends DomainResource implements Serializable

serialVersionUID:

-1910594688L

Serialized Fields

administeredBy

Reference administeredBy

An organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner.

administeredByTarget

Organization administeredByTarget

The actual object that is the target of the reference (An organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner.)

alias

List<StringType> alias

A list of alternate names that the product is known as, or was known as in the past.

contact

List<InsurancePlan.InsurancePlanContactComponent> contact

The contact for the health insurance product for a certain purpose.

coverage

List<InsurancePlan.InsurancePlanCoverageComponent> coverage

Details about the coverage offered by the insurance product.

coverageArea

List<Reference> coverageArea

The geographic region in which a health insurance product's benefits apply.

coverageAreaTarget

List<Location> coverageAreaTarget

The actual objects that are the target of the reference (The geographic region in which a health insurance product's benefits apply.)

endpoint

List<Reference> endpoint

The technical endpoints providing access to services operated for the health insurance product.

endpointTarget

List<Endpoint> endpointTarget

The actual objects that are the target of the reference (The technical endpoints providing access to services operated for the health insurance product.)

identifier

List<Identifier> identifier

Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server.

name

StringType name

Official name of the health insurance product as designated by the owner.

network

List<Reference> network

Reference to the network included in the health insurance product.

networkTarget

List<Organization> networkTarget

The actual objects that are the target of the reference (Reference to the network included in the health insurance product.)

ownedBy

Reference ownedBy

The entity that is providing the health insurance product and underwriting the risk. This is typically an insurance carriers, other third-party payers, or health plan sponsors comonly referred to as 'payers'.

ownedByTarget

Organization ownedByTarget

The actual object that is the target of the reference (The entity that is providing the health insurance product and underwriting the risk. This is typically an insurance carriers, other third-party payers, or health plan sponsors comonly referred to as 'payers'.)

period

Period period

The period of time that the health insurance product is available.

plan

List<InsurancePlan.InsurancePlanPlanComponent> plan

Details about an insurance plan.

status

Enumeration<Enumerations.PublicationStatus> status

The current state of the health insurance product.

type

List<CodeableConcept> type

The kind of health insurance product.

Class org.hl7.fhir.r4.model.InsurancePlan.CoverageBenefitComponent

class CoverageBenefitComponent extends BackboneElement implements Serializable

serialVersionUID:

-113658449L

Serialized Fields

limit

List<InsurancePlan.CoverageBenefitLimitComponent> limit

The specific limits on the benefit.

requirement

StringType requirement

The referral requirements to have access/coverage for this benefit.

type

CodeableConcept type

Type of benefit (primary care; speciality care; inpatient; outpatient).

Class org.hl7.fhir.r4.model.InsurancePlan.CoverageBenefitLimitComponent

class CoverageBenefitLimitComponent extends BackboneElement implements Serializable

serialVersionUID:

-304318128L

Serialized Fields

code

CodeableConcept code

The specific limit on the benefit.

value

Quantity value

The maximum amount of a service item a plan will pay for a covered benefit. For examples. wellness visits, or eyeglasses.

Class org.hl7.fhir.r4.model.InsurancePlan.InsurancePlanContactComponent

class InsurancePlanContactComponent extends BackboneElement implements Serializable

serialVersionUID:

1831121305L

Serialized Fields

address

Address address

Visiting or postal addresses for the contact.

name

HumanName name

A name associated with the contact.

purpose

CodeableConcept purpose

Indicates a purpose for which the contact can be reached.

telecom

List<ContactPoint> telecom

A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.

Class org.hl7.fhir.r4.model.InsurancePlan.InsurancePlanCoverageComponent

class InsurancePlanCoverageComponent extends BackboneElement implements Serializable

serialVersionUID:

-1186191877L

Serialized Fields

benefit

List<InsurancePlan.CoverageBenefitComponent> benefit

Specific benefits under this type of coverage.

network

List<Reference> network

Reference to the network that providing the type of coverage.

networkTarget

List<Organization> networkTarget

The actual objects that are the target of the reference (Reference to the network that providing the type of coverage.)

type

CodeableConcept type

Type of coverage (Medical; Dental; Mental Health; Substance Abuse; Vision; Drug; Short Term; Long Term Care; Hospice; Home Health).

Class org.hl7.fhir.r4.model.InsurancePlan.InsurancePlanPlanComponent

class InsurancePlanPlanComponent extends BackboneElement implements Serializable

serialVersionUID:

-2063324071L

Serialized Fields

coverageArea

List<Reference> coverageArea

The geographic region in which a health insurance plan's benefits apply.

coverageAreaTarget

List<Location> coverageAreaTarget

The actual objects that are the target of the reference (The geographic region in which a health insurance plan's benefits apply.)

generalCost

List<InsurancePlan.InsurancePlanPlanGeneralCostComponent> generalCost

Overall costs associated with the plan.

identifier

List<Identifier> identifier

Business identifiers assigned to this health insurance plan which remain constant as the resource is updated and propagates from server to server.

network

List<Reference> network

Reference to the network that providing the type of coverage.

networkTarget

List<Organization> networkTarget

The actual objects that are the target of the reference (Reference to the network that providing the type of coverage.)

specificCost

List<InsurancePlan.InsurancePlanPlanSpecificCostComponent> specificCost

Costs associated with the coverage provided by the product.

type

CodeableConcept type

Type of plan. For example, "Platinum" or "High Deductable".

Class org.hl7.fhir.r4.model.InsurancePlan.InsurancePlanPlanGeneralCostComponent

class InsurancePlanPlanGeneralCostComponent extends BackboneElement implements Serializable

serialVersionUID:

1563949866L

Serialized Fields

comment

StringType comment

Additional information about the general costs associated with this plan.

cost

Money cost

Value of the cost.

groupSize

PositiveIntType groupSize

Number of participants enrolled in the plan.

type

CodeableConcept type

Type of cost.

Class org.hl7.fhir.r4.model.InsurancePlan.InsurancePlanPlanSpecificCostComponent

class InsurancePlanPlanSpecificCostComponent extends BackboneElement implements Serializable

serialVersionUID:

922585525L

Serialized Fields

benefit

List<InsurancePlan.PlanBenefitComponent> benefit

List of the specific benefits under this category of benefit.

category

CodeableConcept category

General category of benefit (Medical; Dental; Vision; Drug; Mental Health; Substance Abuse; Hospice, Home Health).

Class org.hl7.fhir.r4.model.InsurancePlan.PlanBenefitComponent

class PlanBenefitComponent extends BackboneElement implements Serializable

serialVersionUID:

792296200L

Serialized Fields

cost

List<InsurancePlan.PlanBenefitCostComponent> cost

List of the costs associated with a specific benefit.

type

CodeableConcept type

Type of specific benefit (preventative; primary care office visit; speciality office visit; hospitalization; emergency room; urgent care).

Class org.hl7.fhir.r4.model.InsurancePlan.PlanBenefitCostComponent

class PlanBenefitCostComponent extends BackboneElement implements Serializable

serialVersionUID:

-340688733L

Serialized Fields

applicability

CodeableConcept applicability

Whether the cost applies to in-network or out-of-network providers (in-network; out-of-network; other).

qualifiers

List<CodeableConcept> qualifiers

Additional information about the cost, such as information about funding sources (e.g. HSA, HRA, FSA, RRA).

type

CodeableConcept type

Type of cost (copay; individual cap; family cap; coinsurance; deductible).

value

Quantity value

The actual cost value. (some of the costs may be represented as percentages rather than currency, e.g. 10% coinsurance).

Class org.hl7.fhir.r4.model.IntegerType

class IntegerType extends PrimitiveType<Integer> implements Externalizable

serialVersionUID:

3L

Serialization Methods

readExternal

public void readExternal(ObjectInput theIn)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput theOut)
                   throws IOException

Throws:

IOException

Class org.hl7.fhir.r4.model.Invoice

class Invoice extends DomainResource implements Serializable

serialVersionUID:

-62357265L

Serialized Fields

account

Reference account

Account which is supposed to be balanced with this Invoice.

accountTarget

Account accountTarget

The actual object that is the target of the reference (Account which is supposed to be balanced with this Invoice.)

cancelledReason

StringType cancelledReason

In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).

date

DateTimeType date

Date/time(s) of when this Invoice was posted.

identifier

List<Identifier> identifier

Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments.

issuer

Reference issuer

The organizationissuing the Invoice.

issuerTarget

Organization issuerTarget

The actual object that is the target of the reference (The organizationissuing the Invoice.)

lineItem

List<Invoice.InvoiceLineItemComponent> lineItem

Each line item represents one charge for goods and services rendered. Details such as date, code and amount are found in the referenced ChargeItem resource.

note

List<Annotation> note

Comments made about the invoice by the issuer, subject, or other participants.

participant

List<Invoice.InvoiceParticipantComponent> participant

Indicates who or what performed or participated in the charged service.

paymentTerms

MarkdownType paymentTerms

Payment details such as banking details, period of payment, deductibles, methods of payment.

recipient

Reference recipient

The individual or Organization responsible for balancing of this invoice.

recipientTarget

Resource recipientTarget

The actual object that is the target of the reference (The individual or Organization responsible for balancing of this invoice.)

status

Enumeration<Invoice.InvoiceStatus> status

The current state of the Invoice.

subject

Reference subject

The individual or set of individuals receiving the goods and services billed in this invoice.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (The individual or set of individuals receiving the goods and services billed in this invoice.)

totalGross

Money totalGross

Invoice total, tax included.

totalNet

Money totalNet

Invoice total , taxes excluded.

totalPriceComponent

List<Invoice.InvoiceLineItemPriceComponentComponent> totalPriceComponent

The total amount for the Invoice may be calculated as the sum of the line items with surcharges/deductions that apply in certain conditions. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the total price was calculated.

type

CodeableConcept type

Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary).

Class org.hl7.fhir.r4.model.Invoice.InvoiceLineItemComponent

class InvoiceLineItemComponent extends BackboneElement implements Serializable

serialVersionUID:

-1013610189L

Serialized Fields

chargeItem

Type chargeItem

The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference.

priceComponent

List<Invoice.InvoiceLineItemPriceComponentComponent> priceComponent

The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice as to how the prices have been calculated.

sequence

PositiveIntType sequence

Sequence in which the items appear on the invoice.

Class org.hl7.fhir.r4.model.Invoice.InvoiceLineItemPriceComponentComponent

class InvoiceLineItemPriceComponentComponent extends BackboneElement implements Serializable

serialVersionUID:

1223988958L

Serialized Fields

amount

Money amount

The amount calculated for this component.

code

CodeableConcept code

A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.

factor

DecimalType factor

The factor that has been applied on the base price for calculating this component.

type

Enumeration<Invoice.InvoicePriceComponentType> type

This code identifies the type of the component.

Class org.hl7.fhir.r4.model.Invoice.InvoiceParticipantComponent

class InvoiceParticipantComponent extends BackboneElement implements Serializable

serialVersionUID:

805521719L

Serialized Fields

actor

Reference actor

The device, practitioner, etc. who performed or participated in the service.

actorTarget

Resource actorTarget

The actual object that is the target of the reference (The device, practitioner, etc. who performed or participated in the service.)

role

CodeableConcept role

Describes the type of involvement (e.g. transcriptionist, creator etc.). If the invoice has been created automatically, the Participant may be a billing engine or another kind of device.

Class org.hl7.fhir.r4.model.Invoice.InvoicePriceComponentTypeEnumFactory

class InvoicePriceComponentTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Invoice.InvoiceStatusEnumFactory

class InvoiceStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Library

class Library extends MetadataResource implements Serializable

serialVersionUID:

-796686369L

Serialized Fields

approvalDate

DateType approvalDate

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

author

List<ContactDetail> author

An individiual or organization primarily involved in the creation and maintenance of the content.

content

List<Attachment> content

The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.

copyright

MarkdownType copyright

A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library.

dataRequirement

List<DataRequirement> dataRequirement

Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.

editor

List<ContactDetail> editor

An individual or organization primarily responsible for internal coherence of the content.

effectivePeriod

Period effectivePeriod

The period during which the library content was or is planned to be in active use.

endorser

List<ContactDetail> endorser

An individual or organization responsible for officially endorsing the content for use in some setting.

identifier

List<Identifier> identifier

A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.

lastReviewDate

DateType lastReviewDate

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

parameter

List<ParameterDefinition> parameter

The parameter element defines parameters used by the library.

purpose

MarkdownType purpose

Explanation of why this library is needed and why it has been designed as it has.

relatedArtifact

List<RelatedArtifact> relatedArtifact

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

reviewer

List<ContactDetail> reviewer

An individual or organization primarily responsible for review of some aspect of the content.

subject

Type subject

A code or group definition that describes the intended subject of the contents of the library.

subtitle

StringType subtitle

An explanatory or alternate title for the library giving additional information about its content.

topic

List<CodeableConcept> topic

Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching.

type

CodeableConcept type

Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.

usage

StringType usage

A detailed description of how the library is used from a clinical perspective.

Class org.hl7.fhir.r4.model.Linkage

class Linkage extends DomainResource implements Serializable

serialVersionUID:

25900306L

Serialized Fields

active

BooleanType active

Indicates whether the asserted set of linkages are considered to be "in effect".

author

Reference author

Identifies the user or organization responsible for asserting the linkages as well as the user or organization who establishes the context in which the nature of each linkage is evaluated.

authorTarget

Resource authorTarget

The actual object that is the target of the reference (Identifies the user or organization responsible for asserting the linkages as well as the user or organization who establishes the context in which the nature of each linkage is evaluated.)

item

List<Linkage.LinkageItemComponent> item

Identifies which record considered as the reference to the same real-world occurrence as well as how the items should be evaluated within the collection of linked items.

Class org.hl7.fhir.r4.model.Linkage.LinkageItemComponent

class LinkageItemComponent extends BackboneElement implements Serializable

serialVersionUID:

-209332008L

Serialized Fields

resource

Reference resource

The resource instance being linked as part of the group.

resourceTarget

Resource resourceTarget

The actual object that is the target of the reference (The resource instance being linked as part of the group.)

type

Enumeration<Linkage.LinkageType> type

Distinguishes which item is "source of truth" (if any) and which items are no longer considered to be current representations.

Class org.hl7.fhir.r4.model.Linkage.LinkageTypeEnumFactory

class LinkageTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ListResource

class ListResource extends DomainResource implements Serializable

serialVersionUID:

2071342704L

Serialized Fields

code

CodeableConcept code

This code defines the purpose of the list - why it was created.

date

DateTimeType date

The date that the list was prepared.

emptyReason

CodeableConcept emptyReason

If the list is empty, why the list is empty.

encounter

Reference encounter

The encounter that is the context in which this list was created.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (The encounter that is the context in which this list was created.)

entry

List<ListResource.ListEntryComponent> entry

Entries in this list.

identifier

List<Identifier> identifier

Identifier for the List assigned for business purposes outside the context of FHIR.

mode

Enumeration<ListResource.ListMode> mode

How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

note

List<Annotation> note

Comments that apply to the overall list.

orderedBy

CodeableConcept orderedBy

What order applies to the items in the list.

source

Reference source

The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.

sourceTarget

Resource sourceTarget

The actual object that is the target of the reference (The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.)

status

Enumeration<ListResource.ListStatus> status

Indicates the current state of this list.

subject

Reference subject

The common subject (or patient) of the resources that are in the list if there is one.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (The common subject (or patient) of the resources that are in the list if there is one.)

title

StringType title

A label for the list assigned by the author.

Class org.hl7.fhir.r4.model.ListResource.ListEntryComponent

class ListEntryComponent extends BackboneElement implements Serializable

serialVersionUID:

-758164425L

Serialized Fields

date

DateTimeType date

When this item was added to the list.

deleted

BooleanType deleted

True if this item is marked as deleted in the list.

flag

CodeableConcept flag

The flag allows the system constructing the list to indicate the role and significance of the item in the list.

item

Reference item

A reference to the actual resource from which data was derived.

itemTarget

Resource itemTarget

The actual object that is the target of the reference (A reference to the actual resource from which data was derived.)

Class org.hl7.fhir.r4.model.ListResource.ListModeEnumFactory

class ListModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ListResource.ListStatusEnumFactory

class ListStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Location

class Location extends DomainResource implements Serializable

serialVersionUID:

-2126621333L

Serialized Fields

address

Address address

Physical location.

alias

List<StringType> alias

A list of alternate names that the location is known as, or was known as, in the past.

availabilityExceptions

StringType availabilityExceptions

A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.

description

StringType description

Description of the Location, which helps in finding or referencing the place.

endpoint

List<Reference> endpoint

Technical endpoints providing access to services operated for the location.

endpointTarget

List<Endpoint> endpointTarget

The actual objects that are the target of the reference (Technical endpoints providing access to services operated for the location.)

hoursOfOperation

List<Location.LocationHoursOfOperationComponent> hoursOfOperation

What days/times during a week is this location usually open.

identifier

List<Identifier> identifier

Unique code or number identifying the location to its users.

managingOrganization

Reference managingOrganization

The organization responsible for the provisioning and upkeep of the location.

managingOrganizationTarget

Organization managingOrganizationTarget

The actual object that is the target of the reference (The organization responsible for the provisioning and upkeep of the location.)

mode

Enumeration<Location.LocationMode> mode

Indicates whether a resource instance represents a specific location or a class of locations.

name

StringType name

Name of the location as used by humans. Does not need to be unique.

operationalStatus

Coding operationalStatus

The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.

partOf

Reference partOf

Another Location of which this Location is physically a part of.

partOfTarget

Location partOfTarget

The actual object that is the target of the reference (Another Location of which this Location is physically a part of.)

physicalType

CodeableConcept physicalType

Physical form of the location, e.g. building, room, vehicle, road.

position

Location.LocationPositionComponent position

The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).

status

Enumeration<Location.LocationStatus> status

The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.

telecom

List<ContactPoint> telecom

The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.

type

List<CodeableConcept> type

Indicates the type of function performed at the location.

Class org.hl7.fhir.r4.model.Location.DaysOfWeekEnumFactory

class DaysOfWeekEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Location.LocationHoursOfOperationComponent

class LocationHoursOfOperationComponent extends BackboneElement implements Serializable

serialVersionUID:

-932551849L

Serialized Fields

allDay

BooleanType allDay

The Location is open all day.

closingTime

TimeType closingTime

Time that the Location closes.

daysOfWeek

List<Enumeration<Location.DaysOfWeek>> daysOfWeek

Indicates which days of the week are available between the start and end Times.

openingTime

TimeType openingTime

Time that the Location opens.

Class org.hl7.fhir.r4.model.Location.LocationModeEnumFactory

class LocationModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Location.LocationPositionComponent

class LocationPositionComponent extends BackboneElement implements Serializable

serialVersionUID:

-74276134L

Serialized Fields

altitude

DecimalType altitude

Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).

latitude

DecimalType latitude

Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).

longitude

DecimalType longitude

Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).

Class org.hl7.fhir.r4.model.Location.LocationStatusEnumFactory

class LocationStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.MarkdownType

class MarkdownType extends StringType implements Externalizable

serialVersionUID:

3L

Serialization Methods

readExternal

public void readExternal(ObjectInput theIn)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput theOut)
                   throws IOException

Throws:

IOException

Class org.hl7.fhir.r4.model.MarketingStatus

class MarketingStatus extends BackboneType implements Serializable

serialVersionUID:

-1445736863L

Serialized Fields

country

CodeableConcept country

The country in which the marketing authorisation has been granted shall be specified It should be specified using the ISO 3166 ? 1 alpha-2 code elements.

dateRange

Period dateRange

The date when the Medicinal Product is placed on the market by the Marketing Authorisation Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE ?Placed on the market? refers to the release of the Medicinal Product into the distribution chain.

jurisdiction

CodeableConcept jurisdiction

Where a Medicines Regulatory Agency has granted a marketing authorisation for which specific provisions within a jurisdiction apply, the jurisdiction can be specified using an appropriate controlled terminology The controlled term and the controlled term identifier shall be specified.

restoreDate

DateTimeType restoreDate

The date when the Medicinal Product is placed on the market by the Marketing Authorisation Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE ?Placed on the market? refers to the release of the Medicinal Product into the distribution chain.

status

CodeableConcept status

This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples.

Class org.hl7.fhir.r4.model.Measure

class Measure extends MetadataResource implements Serializable

serialVersionUID:

341731972L

Serialized Fields

approvalDate

DateType approvalDate

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

author

List<ContactDetail> author

An individiual or organization primarily involved in the creation and maintenance of the content.

clinicalRecommendationStatement

MarkdownType clinicalRecommendationStatement

Provides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.

compositeScoring

CodeableConcept compositeScoring

If this is a composite measure, the scoring method used to combine the component measures to determine the composite score.

copyright

MarkdownType copyright

A copyright statement relating to the measure and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the measure.

definition

List<MarkdownType> definition

Provides a description of an individual term used within the measure.

disclaimer

MarkdownType disclaimer

Notices and disclaimers regarding the use of the measure or related to intellectual property (such as code systems) referenced by the measure.

editor

List<ContactDetail> editor

An individual or organization primarily responsible for internal coherence of the content.

effectivePeriod

Period effectivePeriod

The period during which the measure content was or is planned to be in active use.

endorser

List<ContactDetail> endorser

An individual or organization responsible for officially endorsing the content for use in some setting.

group

List<Measure.MeasureGroupComponent> group

A group of population criteria for the measure.

guidance

MarkdownType guidance

Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.

identifier

List<Identifier> identifier

A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance.

improvementNotation

CodeableConcept improvementNotation

Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range).

lastReviewDate

DateType lastReviewDate

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

library

List<CanonicalType> library

A reference to a Library resource containing the formal logic used by the measure.

purpose

MarkdownType purpose

Explanation of why this measure is needed and why it has been designed as it has.

rateAggregation

StringType rateAggregation

Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result.

rationale

MarkdownType rationale

Provides a succinct statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.

relatedArtifact

List<RelatedArtifact> relatedArtifact

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

reviewer

List<ContactDetail> reviewer

An individual or organization primarily responsible for review of some aspect of the content.

riskAdjustment

StringType riskAdjustment

A description of the risk adjustment factors that may impact the resulting score for the measure and how they may be accounted for when computing and reporting measure results.

scoring

CodeableConcept scoring

Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented.

subject

Type subject

The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything.

subtitle

StringType subtitle

An explanatory or alternate title for the measure giving additional information about its content.

supplementalData

List<Measure.MeasureSupplementalDataComponent> supplementalData

The supplemental data criteria for the measure report, specified as either the name of a valid CQL expression within a referenced library, or a valid FHIR Resource Path.

topic

List<CodeableConcept> topic

Descriptive topics related to the content of the measure. Topics provide a high-level categorization grouping types of measures that can be useful for filtering and searching.

type

List<CodeableConcept> type

Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization.

usage

StringType usage

A detailed description, from a clinical perspective, of how the measure is used.

Class org.hl7.fhir.r4.model.Measure.MeasureGroupComponent

class MeasureGroupComponent extends BackboneElement implements Serializable

serialVersionUID:

-1797567579L

Serialized Fields

code

CodeableConcept code

Indicates a meaning for the group. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing groups to be correlated across measures.

description

StringType description

The human readable description of this population group.

population

List<Measure.MeasureGroupPopulationComponent> population

A population criteria for the measure.

stratifier

List<Measure.MeasureGroupStratifierComponent> stratifier

The stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.

Class org.hl7.fhir.r4.model.Measure.MeasureGroupPopulationComponent

class MeasureGroupPopulationComponent extends BackboneElement implements Serializable

serialVersionUID:

2107514056L

Serialized Fields

code

CodeableConcept code

The type of population criteria.

criteria

Expression criteria

An expression that specifies the criteria for the population, typically the name of an expression in a library.

description

StringType description

The human readable description of this population criteria.

Class org.hl7.fhir.r4.model.Measure.MeasureGroupStratifierComponent

class MeasureGroupStratifierComponent extends BackboneElement implements Serializable

serialVersionUID:

-1706793609L

Serialized Fields

code

CodeableConcept code

Indicates a meaning for the stratifier. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing stratifiers to be correlated across measures.

component

List<Measure.MeasureGroupStratifierComponentComponent> component

A component of the stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.

criteria

Expression criteria

An expression that specifies the criteria for the stratifier. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element.

description

StringType description

The human readable description of this stratifier criteria.

Class org.hl7.fhir.r4.model.Measure.MeasureGroupStratifierComponentComponent

class MeasureGroupStratifierComponentComponent extends BackboneElement implements Serializable

serialVersionUID:

2107514056L

Serialized Fields

code

CodeableConcept code

Indicates a meaning for the stratifier component. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing stratifiers to be correlated across measures.

criteria

Expression criteria

An expression that specifies the criteria for this component of the stratifier. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element.

description

StringType description

The human readable description of this stratifier criteria component.

Class org.hl7.fhir.r4.model.Measure.MeasureSupplementalDataComponent

class MeasureSupplementalDataComponent extends BackboneElement implements Serializable

serialVersionUID:

-1897021670L

Serialized Fields

code

CodeableConcept code

Indicates a meaning for the supplemental data. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing supplemental data to be correlated across measures.

criteria

Expression criteria

The criteria for the supplemental data. This is typically the name of a valid expression defined within a referenced library, but it may also be a path to a specific data element. The criteria defines the data to be returned for this element.

description

StringType description

The human readable description of this supplemental data.

usage

List<CodeableConcept> usage

An indicator of the intended usage for the supplemental data element. Supplemental data indicates the data is additional information requested to augment the measure information. Risk adjustment factor indicates the data is additional information used to calculate risk adjustment factors when applying a risk model to the measure calculation.

Class org.hl7.fhir.r4.model.MeasureReport

class MeasureReport extends DomainResource implements Serializable

serialVersionUID:

355307999L

Serialized Fields

date

DateTimeType date

The date this measure report was generated.

evaluatedResource

List<Reference> evaluatedResource

A reference to a Bundle containing the Resources that were used in the calculation of this measure.

evaluatedResourceTarget

List<Resource> evaluatedResourceTarget

The actual objects that are the target of the reference (A reference to a Bundle containing the Resources that were used in the calculation of this measure.)

group

List<MeasureReport.MeasureReportGroupComponent> group

The results of the calculation, one for each population group in the measure.

identifier

List<Identifier> identifier

A formal identifier that is used to identify this MeasureReport when it is represented in other formats or referenced in a specification, model, design or an instance.

improvementNotation

CodeableConcept improvementNotation

Whether improvement in the measure is noted by an increase or decrease in the measure score.

measure

CanonicalType measure

A reference to the Measure that was calculated to produce this report.

period

Period period

The reporting period for which the report was calculated.

reporter

Reference reporter

The individual, location, or organization that is reporting the data.

reporterTarget

Resource reporterTarget

The actual object that is the target of the reference (The individual, location, or organization that is reporting the data.)

status

Enumeration<MeasureReport.MeasureReportStatus> status

The MeasureReport status. No data will be available until the MeasureReport status is complete.

subject

Reference subject

Optional subject identifying the individual or individuals the report is for.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (Optional subject identifying the individual or individuals the report is for.)

type

Enumeration<MeasureReport.MeasureReportType> type

The type of measure report. This may be an individual report, which provides the score for the measure for an individual member of the population; a subject-listing, which returns the list of members that meet the various criteria in the measure; a summary report, which returns a population count for each of the criteria in the measure; or a data-collection, which enables the MeasureReport to be used to exchange the data-of-interest for a quality measure.

Class org.hl7.fhir.r4.model.MeasureReport.MeasureReportGroupComponent

class MeasureReportGroupComponent extends BackboneElement implements Serializable

serialVersionUID:

1744426009L

Serialized Fields

code

CodeableConcept code

The meaning of the population group as defined in the measure definition.

measureScore

Quantity measureScore

The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group.

population

List<MeasureReport.MeasureReportGroupPopulationComponent> population

The populations that make up the population group, one for each type of population appropriate for the measure.

stratifier

List<MeasureReport.MeasureReportGroupStratifierComponent> stratifier

When a measure includes multiple stratifiers, there will be a stratifier group for each stratifier defined by the measure.

Class org.hl7.fhir.r4.model.MeasureReport.MeasureReportGroupPopulationComponent

class MeasureReportGroupPopulationComponent extends BackboneElement implements Serializable

serialVersionUID:

210461445L

Serialized Fields

code

CodeableConcept code

The type of the population.

count

IntegerType count

The number of members of the population.

subjectResults

Reference subjectResults

This element refers to a List of subject level MeasureReport resources, one for each subject in this population.

subjectResultsTarget

ListResource subjectResultsTarget

The actual object that is the target of the reference (This element refers to a List of subject level MeasureReport resources, one for each subject in this population.)

Class org.hl7.fhir.r4.model.MeasureReport.MeasureReportGroupStratifierComponent

class MeasureReportGroupStratifierComponent extends BackboneElement implements Serializable

serialVersionUID:

259550185L

Serialized Fields

code

List<CodeableConcept> code

The meaning of this stratifier, as defined in the measure definition.

stratum

List<MeasureReport.StratifierGroupComponent> stratum

This element contains the results for a single stratum within the stratifier. For example, when stratifying on administrative gender, there will be four strata, one for each possible gender value.

Class org.hl7.fhir.r4.model.MeasureReport.MeasureReportStatusEnumFactory

class MeasureReportStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.MeasureReport.MeasureReportTypeEnumFactory

class MeasureReportTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.MeasureReport.StratifierGroupComponent

class StratifierGroupComponent extends BackboneElement implements Serializable

serialVersionUID:

892251179L

Serialized Fields

component

List<MeasureReport.StratifierGroupComponentComponent> component

A stratifier component value.

measureScore

Quantity measureScore

The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum.

population

List<MeasureReport.StratifierGroupPopulationComponent> population

The populations that make up the stratum, one for each type of population appropriate to the measure.

value

CodeableConcept value

The value for this stratum, expressed as a CodeableConcept. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is unique.

Class org.hl7.fhir.r4.model.MeasureReport.StratifierGroupComponentComponent

class StratifierGroupComponentComponent extends BackboneElement implements Serializable

serialVersionUID:

1750253426L

Serialized Fields

code

CodeableConcept code

The code for the stratum component value.

value

CodeableConcept value

The stratum component value.

Class org.hl7.fhir.r4.model.MeasureReport.StratifierGroupPopulationComponent

class StratifierGroupPopulationComponent extends BackboneElement implements Serializable

serialVersionUID:

210461445L

Serialized Fields

code

CodeableConcept code

The type of the population.

count

IntegerType count

The number of members of the population in this stratum.

subjectResults

Reference subjectResults

This element refers to a List of subject level MeasureReport resources, one for each subject in this population in this stratum.

subjectResultsTarget

ListResource subjectResultsTarget

The actual object that is the target of the reference (This element refers to a List of subject level MeasureReport resources, one for each subject in this population in this stratum.)

Class org.hl7.fhir.r4.model.Media

class Media extends DomainResource implements Serializable

serialVersionUID:

2069980126L

Serialized Fields

basedOn

List<Reference> basedOn

A procedure that is fulfilled in whole or in part by the creation of this media.

basedOnTarget

List<Resource> basedOnTarget

The actual objects that are the target of the reference (A procedure that is fulfilled in whole or in part by the creation of this media.)

bodySite

CodeableConcept bodySite

Indicates the site on the subject's body where the observation was made (i.e. the target site).

content

Attachment content

The actual content of the media - inline or by direct reference to the media source file.

created

Type created

The date and time(s) at which the media was collected.

device

Reference device

The device used to collect the media.

deviceName

StringType deviceName

The name of the device / manufacturer of the device that was used to make the recording.

deviceTarget

Resource deviceTarget

The actual object that is the target of the reference (The device used to collect the media.)

duration

DecimalType duration

The duration of the recording in seconds - for audio and video.

encounter

Reference encounter

The encounter that establishes the context for this media.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (The encounter that establishes the context for this media.)

frames

PositiveIntType frames

The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.

height

PositiveIntType height

Height of the image in pixels (photo/video).

identifier

List<Identifier> identifier

Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers.

issued

InstantType issued

The date and time this version of the media was made available to providers, typically after having been reviewed.

modality

CodeableConcept modality

Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality.

note

List<Annotation> note

Comments made about the media by the performer, subject or other participants.

operator

Reference operator

The person who administered the collection of the image.

operatorTarget

Resource operatorTarget

The actual object that is the target of the reference (The person who administered the collection of the image.)

partOf

List<Reference> partOf

A larger event of which this particular event is a component or step.

partOfTarget

List<Resource> partOfTarget

The actual objects that are the target of the reference (A larger event of which this particular event is a component or step.)

reasonCode

List<CodeableConcept> reasonCode

Describes why the event occurred in coded or textual form.

status

Enumeration<Media.MediaStatus> status

The current state of the {{title}}.

subject

Reference subject

Who/What this Media is a record of.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (Who/What this Media is a record of.)

type

CodeableConcept type

A code that classifies whether the media is an image, video or audio recording or some other media category.

view

CodeableConcept view

The name of the imaging view e.g. Lateral or Antero-posterior (AP).

width

PositiveIntType width

Width of the image in pixels (photo/video).

Class org.hl7.fhir.r4.model.Media.MediaStatusEnumFactory

class MediaStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Medication

class Medication extends DomainResource implements Serializable

serialVersionUID:

781229373L

Serialized Fields

amount

Ratio amount

Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).

batch

Medication.MedicationBatchComponent batch

Information that only applies to packages (not products).

code

CodeableConcept code

A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.

form

CodeableConcept form

Describes the form of the item. Powder; tablets; capsule.

identifier

List<Identifier> identifier

Business identifier for this medication.

ingredient

List<Medication.MedicationIngredientComponent> ingredient

Identifies a particular constituent of interest in the product.

manufacturer

Reference manufacturer

Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.

manufacturerTarget

Organization manufacturerTarget

The actual object that is the target of the reference (Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.)

status

Enumeration<Medication.MedicationStatus> status

A code to indicate if the medication is in active use.

Class org.hl7.fhir.r4.model.Medication.MedicationBatchComponent

class MedicationBatchComponent extends BackboneElement implements Serializable

serialVersionUID:

1982738755L

Serialized Fields

expirationDate

DateTimeType expirationDate

When this specific batch of product will expire.

lotNumber

StringType lotNumber

The assigned lot number of a batch of the specified product.

Class org.hl7.fhir.r4.model.Medication.MedicationIngredientComponent

class MedicationIngredientComponent extends BackboneElement implements Serializable

serialVersionUID:

1365103497L

Serialized Fields

isActive

BooleanType isActive

Indication of whether this ingredient affects the therapeutic action of the drug.

item

Type item

The actual ingredient - either a substance (simple ingredient) or another medication of a medication.

strength

Ratio strength

Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.

Class org.hl7.fhir.r4.model.Medication.MedicationStatusEnumFactory

class MedicationStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.MedicationAdministration

class MedicationAdministration extends DomainResource implements Serializable

serialVersionUID:

463158971L

Serialized Fields

category

CodeableConcept category

Indicates where the medication is expected to be consumed or administered.

context

Reference context

The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.

contextTarget

Resource contextTarget

The actual object that is the target of the reference (The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.)

device

List<Reference> device

The device used in administering the medication to the patient. For example, a particular infusion pump.

deviceTarget

List<Device> deviceTarget

The actual objects that are the target of the reference (The device used in administering the medication to the patient. For example, a particular infusion pump.)

dosage

MedicationAdministration.MedicationAdministrationDosageComponent dosage

Describes the medication dosage information details e.g. dose, rate, site, route, etc.

effective

Type effective

A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.

eventHistory

List<Reference> eventHistory

A summary of the events of interest that have occurred, such as when the administration was verified.

eventHistoryTarget

List<Provenance> eventHistoryTarget

The actual objects that are the target of the reference (A summary of the events of interest that have occurred, such as when the administration was verified.)

identifier

List<Identifier> identifier

Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.

instantiates

List<UriType> instantiates

A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.

medication

Type medication

Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.

note

List<Annotation> note

Extra information about the medication administration that is not conveyed by the other attributes.

partOf

List<Reference> partOf

A larger event of which this particular event is a component or step.

partOfTarget

List<Resource> partOfTarget

The actual objects that are the target of the reference (A larger event of which this particular event is a component or step.)

performer

List<MedicationAdministration.MedicationAdministrationPerformerComponent> performer

Indicates who or what performed the medication administration and how they were involved.

reasonCode

List<CodeableConcept> reasonCode

A code indicating why the medication was given.

reasonReference

List<Reference> reasonReference

Condition or observation that supports why the medication was administered.

reasonReferenceTarget

List<Resource> reasonReferenceTarget

The actual objects that are the target of the reference (Condition or observation that supports why the medication was administered.)

request

Reference request

The original request, instruction or authority to perform the administration.

requestTarget

MedicationRequest requestTarget

The actual object that is the target of the reference (The original request, instruction or authority to perform the administration.)

status

Enumeration<MedicationAdministration.MedicationAdministrationStatus> status

Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.

statusReason

List<CodeableConcept> statusReason

A code indicating why the administration was not performed.

subject

Reference subject

The person or animal or group receiving the medication.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (The person or animal or group receiving the medication.)

supportingInformation

List<Reference> supportingInformation

Additional information (for example, patient height and weight) that supports the administration of the medication.

supportingInformationTarget

List<Resource> supportingInformationTarget

The actual objects that are the target of the reference (Additional information (for example, patient height and weight) that supports the administration of the medication.)

Class org.hl7.fhir.r4.model.MedicationAdministration.MedicationAdministrationDosageComponent

class MedicationAdministrationDosageComponent extends BackboneElement implements Serializable

serialVersionUID:

947835626L

Serialized Fields

dose

Quantity dose

The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.

method

CodeableConcept method

A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV.

rate

Type rate

Identifies the speed with which the medication was or will be introduced into the patient. Typically, the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time, e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.

route

CodeableConcept route

A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.

site

CodeableConcept site

A coded specification of the anatomic site where the medication first entered the body. For example, "left arm".

text

StringType text

Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans. The dosage instructions should reflect the dosage of the medication that was administered.

Class org.hl7.fhir.r4.model.MedicationAdministration.MedicationAdministrationPerformerComponent

class MedicationAdministrationPerformerComponent extends BackboneElement implements Serializable

serialVersionUID:

1424001049L

Serialized Fields

actor

Reference actor

Indicates who or what performed the medication administration.

actorTarget

Resource actorTarget

The actual object that is the target of the reference (Indicates who or what performed the medication administration.)

function

CodeableConcept function

Distinguishes the type of involvement of the performer in the medication administration.

Class org.hl7.fhir.r4.model.MedicationAdministration.MedicationAdministrationStatusEnumFactory

class MedicationAdministrationStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.MedicationDispense

class MedicationDispense extends DomainResource implements Serializable

serialVersionUID:

-976967238L

Serialized Fields

authorizingPrescription

List<Reference> authorizingPrescription

Indicates the medication order that is being dispensed against.

authorizingPrescriptionTarget

List<MedicationRequest> authorizingPrescriptionTarget

The actual objects that are the target of the reference (Indicates the medication order that is being dispensed against.)

category

CodeableConcept category

Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).

context

Reference context

The encounter or episode of care that establishes the context for this event.

contextTarget

Resource contextTarget

The actual object that is the target of the reference (The encounter or episode of care that establishes the context for this event.)

daysSupply

Quantity daysSupply

The amount of medication expressed as a timing amount.

destination

Reference destination

Identification of the facility/location where the medication was shipped to, as part of the dispense event.

destinationTarget

Location destinationTarget

The actual object that is the target of the reference (Identification of the facility/location where the medication was shipped to, as part of the dispense event.)

detectedIssue

List<Reference> 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, duplicate therapy, dosage alert etc.

detectedIssueTarget

List<DetectedIssue> detectedIssueTarget

The actual objects that are the target of the reference (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, duplicate therapy, dosage alert etc.)

dosageInstruction

List<Dosage> dosageInstruction

Indicates how the medication is to be used by the patient.

eventHistory

List<Reference> eventHistory

A summary of the events of interest that have occurred, such as when the dispense was verified.

eventHistoryTarget

List<Provenance> eventHistoryTarget

The actual objects that are the target of the reference (A summary of the events of interest that have occurred, such as when the dispense was verified.)

identifier

List<Identifier> identifier

Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.

location

Reference location

The principal physical location where the dispense was performed.

locationTarget

Location locationTarget

The actual object that is the target of the reference (The principal physical location where the dispense was performed.)

medication

Type medication

Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.

note

List<Annotation> note

Extra information about the dispense that could not be conveyed in the other attributes.

partOf

List<Reference> partOf

The procedure that trigger the dispense.

partOfTarget

List<Procedure> partOfTarget

The actual objects that are the target of the reference (The procedure that trigger the dispense.)

performer

List<MedicationDispense.MedicationDispensePerformerComponent> performer

Indicates who or what performed the event.

quantity

Quantity quantity

The amount of medication that has been dispensed. Includes unit of measure.

receiver

List<Reference> receiver

Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.

receiverTarget

List<Resource> receiverTarget

The actual objects that are the target of the reference (Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.)

status

Enumeration<MedicationDispense.MedicationDispenseStatus> status

A code specifying the state of the set of dispense events.

statusReason

Type statusReason

Indicates the reason why a dispense was not performed.

subject

Reference subject

A link to a resource representing the person or the group to whom the medication will be given.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (A link to a resource representing the person or the group to whom the medication will be given.)

substitution

MedicationDispense.MedicationDispenseSubstitutionComponent substitution

Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.

supportingInformation

List<Reference> supportingInformation

Additional information that supports the medication being dispensed.

supportingInformationTarget

List<Resource> supportingInformationTarget

The actual objects that are the target of the reference (Additional information that supports the medication being dispensed.)

type

CodeableConcept type

Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

whenHandedOver

DateTimeType whenHandedOver

The time the dispensed product was provided to the patient or their representative.

whenPrepared

DateTimeType whenPrepared

The time when the dispensed product was packaged and reviewed.

Class org.hl7.fhir.r4.model.MedicationDispense.MedicationDispensePerformerComponent

class MedicationDispensePerformerComponent extends BackboneElement implements Serializable

serialVersionUID:

1424001049L

Serialized Fields

actor

Reference actor

The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication.

actorTarget

Resource actorTarget

The actual object that is the target of the reference (The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication.)

function

CodeableConcept function

Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.

Class org.hl7.fhir.r4.model.MedicationDispense.MedicationDispenseStatusEnumFactory

class MedicationDispenseStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.MedicationDispense.MedicationDispenseSubstitutionComponent

class MedicationDispenseSubstitutionComponent extends BackboneElement implements Serializable

serialVersionUID:

357914571L

Serialized Fields

reason

List<CodeableConcept> reason

Indicates the reason for the substitution (or lack of substitution) from what was prescribed.

responsibleParty

List<Reference> responsibleParty

The person or organization that has primary responsibility for the substitution.

responsiblePartyTarget

List<Resource> responsiblePartyTarget

The actual objects that are the target of the reference (The person or organization that has primary responsibility for the substitution.)

type

CodeableConcept type

A code signifying whether a different drug was dispensed from what was prescribed.

wasSubstituted

BooleanType wasSubstituted

True if the dispenser dispensed a different drug or product from what was prescribed.

Class org.hl7.fhir.r4.model.MedicationKnowledge

class MedicationKnowledge extends DomainResource implements Serializable

serialVersionUID:

-1230067857L

Serialized Fields

administrationGuidelines

List<MedicationKnowledge.MedicationKnowledgeAdministrationGuidelinesComponent> administrationGuidelines

Guidelines for the administration of the medication.

amount

Quantity amount

Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).

associatedMedication

List<Reference> associatedMedication

Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor).

associatedMedicationTarget

List<Medication> associatedMedicationTarget

The actual objects that are the target of the reference (Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor).)

code

CodeableConcept code

A code that specifies this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.

contraindication

List<Reference> contraindication

Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).

contraindicationTarget

List<DetectedIssue> contraindicationTarget

The actual objects that are the target of the reference (Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).)

cost

List<MedicationKnowledge.MedicationKnowledgeCostComponent> cost

The price of the medication.

doseForm

CodeableConcept doseForm

Describes the form of the item. Powder; tablets; capsule.

drugCharacteristic

List<MedicationKnowledge.MedicationKnowledgeDrugCharacteristicComponent> drugCharacteristic

Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.

ingredient

List<MedicationKnowledge.MedicationKnowledgeIngredientComponent> ingredient

Identifies a particular constituent of interest in the product.

intendedRoute

List<CodeableConcept> intendedRoute

The intended or approved route of administration.

kinetics

List<MedicationKnowledge.MedicationKnowledgeKineticsComponent> kinetics

The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.

manufacturer

Reference manufacturer

Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.

manufacturerTarget

Organization manufacturerTarget

The actual object that is the target of the reference (Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.)

medicineClassification

List<MedicationKnowledge.MedicationKnowledgeMedicineClassificationComponent> medicineClassification

Categorization of the medication within a formulary or classification system.

monitoringProgram

List<MedicationKnowledge.MedicationKnowledgeMonitoringProgramComponent> monitoringProgram

The program under which the medication is reviewed.

monograph

List<MedicationKnowledge.MedicationKnowledgeMonographComponent> monograph

Associated documentation about the medication.

packaging

MedicationKnowledge.MedicationKnowledgePackagingComponent packaging

Information that only applies to packages (not products).

preparationInstruction

MarkdownType preparationInstruction

The instructions for preparing the medication.

productType

List<CodeableConcept> productType

Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).

regulatory

List<MedicationKnowledge.MedicationKnowledgeRegulatoryComponent> regulatory

Regulatory information about a medication.

relatedMedicationKnowledge

List<MedicationKnowledge.MedicationKnowledgeRelatedMedicationKnowledgeComponent> relatedMedicationKnowledge

Associated or related knowledge about a medication.

status

Enumeration<MedicationKnowledge.MedicationKnowledgeStatus> status

A code to indicate if the medication is in active use. The status refers to the validity about the information of the medication and not to its medicinal properties.

synonym

List<StringType> synonym

Additional names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.

Class org.hl7.fhir.r4.model.MedicationKnowledge.MedicationKnowledgeAdministrationGuidelinesComponent

class MedicationKnowledgeAdministrationGuidelinesComponent extends BackboneElement implements Serializable

serialVersionUID:

1196999266L

Serialized Fields

dosage

List<MedicationKnowledge.MedicationKnowledgeAdministrationGuidelinesDosageComponent> dosage

Dosage for the medication for the specific guidelines.

indication

Type indication

Indication for use that apply to the specific administration guidelines.

patientCharacteristics

List<MedicationKnowledge.MedicationKnowledgeAdministrationGuidelinesPatientCharacteristicsComponent> patientCharacteristics

Characteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.).

Class org.hl7.fhir.r4.model.MedicationKnowledge.MedicationKnowledgeAdministrationGuidelinesDosageComponent

class MedicationKnowledgeAdministrationGuidelinesDosageComponent extends BackboneElement implements Serializable

serialVersionUID:

1578257961L

Serialized Fields

dosage

List<Dosage> dosage

Dosage for the medication for the specific guidelines.

type

CodeableConcept type

The type of dosage (for example, prophylaxis, maintenance, therapeutic, etc.).

Class org.hl7.fhir.r4.model.MedicationKnowledge.MedicationKnowledgeAdministrationGuidelinesPatientCharacteristicsComponent

class MedicationKnowledgeAdministrationGuidelinesPatientCharacteristicsComponent extends BackboneElement implements Serializable

serialVersionUID:

-133608297L

Serialized Fields

characteristic

Type characteristic

Specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender).

value

List<StringType> value

The specific characteristic (e.g. height, weight, gender, etc.).

Class org.hl7.fhir.r4.model.MedicationKnowledge.MedicationKnowledgeCostComponent

class MedicationKnowledgeCostComponent extends BackboneElement implements Serializable

serialVersionUID:

244671378L

Serialized Fields

cost

Money cost

The price of the medication.

source

StringType source

The source or owner that assigns the price to the medication.

type

CodeableConcept type

The category of the cost information. For example, manufacturers' cost, patient cost, claim reimbursement cost, actual acquisition cost.

Class org.hl7.fhir.r4.model.MedicationKnowledge.MedicationKnowledgeDrugCharacteristicComponent

class MedicationKnowledgeDrugCharacteristicComponent extends BackboneElement implements Serializable

serialVersionUID:

-491121170L

Serialized Fields

type

CodeableConcept type

A code specifying which characteristic of the medicine is being described (for example, colour, shape, imprint).

value

Type value

Description of the characteristic.

Class org.hl7.fhir.r4.model.MedicationKnowledge.MedicationKnowledgeIngredientComponent

class MedicationKnowledgeIngredientComponent extends BackboneElement implements Serializable

serialVersionUID:

1365103497L

Serialized Fields

isActive

BooleanType isActive

Indication of whether this ingredient affects the therapeutic action of the drug.

item

Type item

The actual ingredient - either a substance (simple ingredient) or another medication.

strength

Ratio strength

Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.

Class org.hl7.fhir.r4.model.MedicationKnowledge.MedicationKnowledgeKineticsComponent

class MedicationKnowledgeKineticsComponent extends BackboneElement implements Serializable

serialVersionUID:

-206244264L

Serialized Fields

areaUnderCurve

List<Quantity> areaUnderCurve

The drug concentration measured at certain discrete points in time.

halfLifePeriod

Duration halfLifePeriod

The time required for any specified property (e.g., the concentration of a substance in the body) to decrease by half.

lethalDose50

List<Quantity> lethalDose50

The median lethal dose of a drug.

Class org.hl7.fhir.r4.model.MedicationKnowledge.MedicationKnowledgeMedicineClassificationComponent

class MedicationKnowledgeMedicineClassificationComponent extends BackboneElement implements Serializable

serialVersionUID:

1562996046L

Serialized Fields

classification

List<CodeableConcept> classification

Specific category assigned to the medication (e.g. anti-infective, anti-hypertensive, antibiotic, etc.).

type

CodeableConcept type

The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification).

Class org.hl7.fhir.r4.model.MedicationKnowledge.MedicationKnowledgeMonitoringProgramComponent

class MedicationKnowledgeMonitoringProgramComponent extends BackboneElement implements Serializable

serialVersionUID:

-280346281L

Serialized Fields

name

StringType name

Name of the reviewing program.

type

CodeableConcept type

Type of program under which the medication is monitored.

Class org.hl7.fhir.r4.model.MedicationKnowledge.MedicationKnowledgeMonographComponent

class MedicationKnowledgeMonographComponent extends BackboneElement implements Serializable

serialVersionUID:

1392095381L

Serialized Fields

source

Reference source

Associated documentation about the medication.

sourceTarget

Resource sourceTarget

The actual object that is the target of the reference (Associated documentation about the medication.)

type

CodeableConcept type

The category of documentation about the medication. (e.g. professional monograph, patient education monograph).

Class org.hl7.fhir.r4.model.MedicationKnowledge.MedicationKnowledgePackagingComponent

class MedicationKnowledgePackagingComponent extends BackboneElement implements Serializable

serialVersionUID:

-308052041L

Serialized Fields

quantity

Quantity quantity

The number of product units the package would contain if fully loaded.

type

CodeableConcept type

A code that defines the specific type of packaging that the medication can be found in (e.g. blister sleeve, tube, bottle).

Class org.hl7.fhir.r4.model.MedicationKnowledge.MedicationKnowledgeRegulatoryComponent

class MedicationKnowledgeRegulatoryComponent extends BackboneElement implements Serializable

serialVersionUID:

-1252605487L

Serialized Fields

maxDispense

MedicationKnowledge.MedicationKnowledgeRegulatoryMaxDispenseComponent maxDispense

The maximum number of units of the medication that can be dispensed in a period.

regulatoryAuthority

Reference regulatoryAuthority

The authority that is specifying the regulations.

regulatoryAuthorityTarget

Organization regulatoryAuthorityTarget

The actual object that is the target of the reference (The authority that is specifying the regulations.)

schedule

List<MedicationKnowledge.MedicationKnowledgeRegulatoryScheduleComponent> schedule

Specifies the schedule of a medication in jurisdiction.

substitution

List<MedicationKnowledge.MedicationKnowledgeRegulatorySubstitutionComponent> substitution

Specifies if changes are allowed when dispensing a medication from a regulatory perspective.

Class org.hl7.fhir.r4.model.MedicationKnowledge.MedicationKnowledgeRegulatoryMaxDispenseComponent

class MedicationKnowledgeRegulatoryMaxDispenseComponent extends BackboneElement implements Serializable

serialVersionUID:

-441724185L

Serialized Fields

period

Duration period

The period that applies to the maximum number of units.

quantity

Quantity quantity

The maximum number of units of the medication that can be dispensed.

Class org.hl7.fhir.r4.model.MedicationKnowledge.MedicationKnowledgeRegulatoryScheduleComponent

class MedicationKnowledgeRegulatoryScheduleComponent extends BackboneElement implements Serializable

serialVersionUID:

1955520912L

Serialized Fields

schedule

CodeableConcept schedule

Specifies the specific drug schedule.

Class org.hl7.fhir.r4.model.MedicationKnowledge.MedicationKnowledgeRegulatorySubstitutionComponent

class MedicationKnowledgeRegulatorySubstitutionComponent extends BackboneElement implements Serializable

serialVersionUID:

396354861L

Serialized Fields

allowed

BooleanType allowed

Specifies if regulation allows for changes in the medication when dispensing.

type

CodeableConcept type

Specifies the type of substitution allowed.

Class org.hl7.fhir.r4.model.MedicationKnowledge.MedicationKnowledgeRelatedMedicationKnowledgeComponent

class MedicationKnowledgeRelatedMedicationKnowledgeComponent extends BackboneElement implements Serializable

serialVersionUID:

1285880636L

Serialized Fields

reference

List<Reference> reference

Associated documentation about the associated medication knowledge.

referenceTarget

List<MedicationKnowledge> referenceTarget

The actual objects that are the target of the reference (Associated documentation about the associated medication knowledge.)

type

CodeableConcept type

The category of the associated medication knowledge reference.

Class org.hl7.fhir.r4.model.MedicationKnowledge.MedicationKnowledgeStatusEnumFactory

class MedicationKnowledgeStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.MedicationRequest

class MedicationRequest extends DomainResource implements Serializable

serialVersionUID:

1313900480L

Serialized Fields

authoredOn

DateTimeType authoredOn

The date (and perhaps time) when the prescription was initially written or authored on.

basedOn

List<Reference> basedOn

A plan or request that is fulfilled in whole or in part by this medication request.

basedOnTarget

List<Resource> basedOnTarget

The actual objects that are the target of the reference (A plan or request that is fulfilled in whole or in part by this medication request.)

category

List<CodeableConcept> category

Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).

courseOfTherapyType

CodeableConcept courseOfTherapyType

The description of the overall patte3rn of the administration of the medication to the patient.

detectedIssue

List<Reference> 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, duplicate therapy, dosage alert etc.

detectedIssueTarget

List<DetectedIssue> detectedIssueTarget

The actual objects that are the target of the reference (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, duplicate therapy, dosage alert etc.)

dispenseRequest

MedicationRequest.MedicationRequestDispenseRequestComponent dispenseRequest

Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.

doNotPerform

BooleanType doNotPerform

If true indicates that the provider is asking for the medication request not to occur.

dosageInstruction

List<Dosage> dosageInstruction

Indicates how the medication is to be used by the patient.

encounter

Reference encounter

The Encounter during which this [x] was created or to which the creation of this record is tightly associated.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (The Encounter during which this [x] was created or to which the creation of this record is tightly associated.)

eventHistory

List<Reference> eventHistory

Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.

eventHistoryTarget

List<Provenance> eventHistoryTarget

The actual objects that are the target of the reference (Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.)

groupIdentifier

Identifier groupIdentifier

A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription.

identifier

List<Identifier> identifier

Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.

instantiatesCanonical

List<CanonicalType> instantiatesCanonical

The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.

instantiatesUri

List<UriType> instantiatesUri

The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationRequest.

insurance

List<Reference> insurance

Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.

insuranceTarget

List<Resource> insuranceTarget

The actual objects that are the target of the reference (Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.)

intent

Enumeration<MedicationRequest.MedicationRequestIntent> intent

Whether the request is a proposal, plan, or an original order.

medication

Type medication

Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.

note

List<Annotation> note

Extra information about the prescription that could not be conveyed by the other attributes.

performer

Reference performer

The specified desired performer of the medication treatment (e.g. the performer of the medication administration).

performerTarget

Resource performerTarget

The actual object that is the target of the reference (The specified desired performer of the medication treatment (e.g. the performer of the medication administration).)

performerType

CodeableConcept performerType

Indicates the type of performer of the administration of the medication.

priority

Enumeration<MedicationRequest.MedicationRequestPriority> priority

Indicates how quickly the Medication Request should be addressed with respect to other requests.

priorPrescription

Reference priorPrescription

A link to a resource representing an earlier order related order or prescription.

priorPrescriptionTarget

MedicationRequest priorPrescriptionTarget

The actual object that is the target of the reference (A link to a resource representing an earlier order related order or prescription.)

reasonCode

List<CodeableConcept> reasonCode

The reason or the indication for ordering or not ordering the medication.

reasonReference

List<Reference> reasonReference

Condition or observation that supports why the medication was ordered.

reasonReferenceTarget

List<Resource> reasonReferenceTarget

The actual objects that are the target of the reference (Condition or observation that supports why the medication was ordered.)

recorder

Reference recorder

The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.

recorderTarget

Resource recorderTarget

The actual object that is the target of the reference (The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.)

reported

Type reported

Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.

requester

Reference requester

The individual, organization, or device that initiated the request and has responsibility for its activation.

requesterTarget

Resource requesterTarget

The actual object that is the target of the reference (The individual, organization, or device that initiated the request and has responsibility for its activation.)

status

Enumeration<MedicationRequest.MedicationRequestStatus> status

A code specifying the current state of the order. Generally, this will be active or completed state.

statusReason

CodeableConcept statusReason

Captures the reason for the current state of the MedicationRequest.

subject

Reference subject

A link to a resource representing the person or set of individuals to whom the medication will be given.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (A link to a resource representing the person or set of individuals to whom the medication will be given.)

substitution

MedicationRequest.MedicationRequestSubstitutionComponent substitution

Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.

supportingInformation

List<Reference> supportingInformation

Include additional information (for example, patient height and weight) that supports the ordering of the medication.

supportingInformationTarget

List<Resource> supportingInformationTarget

The actual objects that are the target of the reference (Include additional information (for example, patient height and weight) that supports the ordering of the medication.)

Class org.hl7.fhir.r4.model.MedicationRequest.MedicationRequestDispenseRequestComponent

class MedicationRequestDispenseRequestComponent extends BackboneElement implements Serializable

serialVersionUID:

-1680129929L

Serialized Fields

dispenseInterval

Duration dispenseInterval

The minimum period of time that must occur between dispenses of the medication.

expectedSupplyDuration

Duration expectedSupplyDuration

Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last.

initialFill

MedicationRequest.MedicationRequestDispenseRequestInitialFillComponent initialFill

Indicates the quantity or duration for the first dispense of the medication.

numberOfRepeatsAllowed

UnsignedIntType numberOfRepeatsAllowed

An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication. Usage Notes: This integer does not include the original order dispense. This means that if an order indicates dispense 30 tablets plus "3 repeats", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets. A prescriber may explicitly say that zero refills are permitted after the initial dispense.

performer

Reference performer

Indicates the intended dispensing Organization specified by the prescriber.

performerTarget

Organization performerTarget

The actual object that is the target of the reference (Indicates the intended dispensing Organization specified by the prescriber.)

quantity

Quantity quantity

The amount that is to be dispensed for one fill.

validityPeriod

Period validityPeriod

This indicates the validity period of a prescription (stale dating the Prescription).

Class org.hl7.fhir.r4.model.MedicationRequest.MedicationRequestDispenseRequestInitialFillComponent

class MedicationRequestDispenseRequestInitialFillComponent extends BackboneElement implements Serializable

serialVersionUID:

1223227956L

Serialized Fields

duration

Duration duration

The length of time that the first dispense is expected to last.

quantity

Quantity quantity

The amount or quantity to provide as part of the first dispense.

Class org.hl7.fhir.r4.model.MedicationRequest.MedicationRequestIntentEnumFactory

class MedicationRequestIntentEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.MedicationRequest.MedicationRequestPriorityEnumFactory

class MedicationRequestPriorityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.MedicationRequest.MedicationRequestStatusEnumFactory

class MedicationRequestStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.MedicationRequest.MedicationRequestSubstitutionComponent

class MedicationRequestSubstitutionComponent extends BackboneElement implements Serializable

serialVersionUID:

547265407L

Serialized Fields

allowed

Type allowed

True if the prescriber allows a different drug to be dispensed from what was prescribed.

reason

CodeableConcept reason

Indicates the reason for the substitution, or why substitution must or must not be performed.

Class org.hl7.fhir.r4.model.MedicationStatement

class MedicationStatement extends DomainResource implements Serializable

serialVersionUID:

1912813418L

Serialized Fields

basedOn

List<Reference> basedOn

A plan, proposal or order that is fulfilled in whole or in part by this event.

basedOnTarget

List<Resource> basedOnTarget

The actual objects that are the target of the reference (A plan, proposal or order that is fulfilled in whole or in part by this event.)

category

CodeableConcept category

Indicates where the medication is expected to be consumed or administered.

context

Reference context

The encounter or episode of care that establishes the context for this MedicationStatement.

contextTarget

Resource contextTarget

The actual object that is the target of the reference (The encounter or episode of care that establishes the context for this MedicationStatement.)

dateAsserted

DateTimeType dateAsserted

The date when the medication statement was asserted by the information source.

derivedFrom

List<Reference> derivedFrom

Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement.

derivedFromTarget

List<Resource> derivedFromTarget

The actual objects that are the target of the reference (Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement.)

dosage

List<Dosage> dosage

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

effective

Type effective

The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.taken element is No).

identifier

List<Identifier> identifier

Identifiers associated with this Medication Statement that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.

informationSource

Reference informationSource

The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g. Claim or MedicationRequest.

informationSourceTarget

Resource informationSourceTarget

The actual object that is the target of the reference (The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g. Claim or MedicationRequest.)

medication

Type medication

Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.

note

List<Annotation> note

Provides extra information about the medication statement that is not conveyed by the other attributes.

partOf

List<Reference> partOf

A larger event of which this particular event is a component or step.

partOfTarget

List<Resource> partOfTarget

The actual objects that are the target of the reference (A larger event of which this particular event is a component or step.)

reasonCode

List<CodeableConcept> reasonCode

A reason for why the medication is being/was taken.

reasonReference

List<Reference> reasonReference

Condition or observation that supports why the medication is being/was taken.

reasonReferenceTarget

List<Resource> reasonReferenceTarget

The actual objects that are the target of the reference (Condition or observation that supports why the medication is being/was taken.)

status

Enumeration<MedicationStatement.MedicationStatementStatus> status

A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally, this will be active or completed.

statusReason

List<CodeableConcept> statusReason

Captures the reason for the current state of the MedicationStatement.

subject

Reference subject

The person, animal or group who is/was taking the medication.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (The person, animal or group who is/was taking the medication.)

Class org.hl7.fhir.r4.model.MedicationStatement.MedicationStatementStatusEnumFactory

class MedicationStatementStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.MedicinalProduct

class MedicinalProduct extends DomainResource implements Serializable

serialVersionUID:

-899196111L

Serialized Fields

additionalMonitoringIndicator

CodeableConcept additionalMonitoringIndicator

Whether the Medicinal Product is subject to additional monitoring for regulatory reasons.

attachedDocument

List<Reference> attachedDocument

Supporting documentation, typically for regulatory submission.

attachedDocumentTarget

List<DocumentReference> attachedDocumentTarget

The actual objects that are the target of the reference (Supporting documentation, typically for regulatory submission.)

clinicalTrial

List<Reference> clinicalTrial

Clinical trials or studies that this product is involved in.

clinicalTrialTarget

List<ResearchStudy> clinicalTrialTarget

The actual objects that are the target of the reference (Clinical trials or studies that this product is involved in.)

combinedPharmaceuticalDoseForm

CodeableConcept combinedPharmaceuticalDoseForm

The dose form for a single part product, or combined form of a multiple part product.

contact

List<Reference> contact

A product specific contact, person (in a role), or an organization.

contactTarget

List<Resource> contactTarget

The actual objects that are the target of the reference (A product specific contact, person (in a role), or an organization.)

crossReference

List<Identifier> crossReference

Reference to another product, e.g. for linking authorised to investigational product.

domain

Coding domain

If this medicine applies to human or veterinary uses.

identifier

List<Identifier> identifier

Business identifier for this product. Could be an MPID.

legalStatusOfSupply

CodeableConcept legalStatusOfSupply

The legal status of supply of the medicinal product as classified by the regulator.

manufacturingBusinessOperation

List<MedicinalProduct.MedicinalProductManufacturingBusinessOperationComponent> manufacturingBusinessOperation

An operation applied to the product, for manufacturing or adminsitrative purpose.

marketingStatus

List<MarketingStatus> marketingStatus

Marketing status of the medicinal product, in contrast to marketing authorizaton.

masterFile

List<Reference> masterFile

A master file for to the medicinal product (e.g. Pharmacovigilance System Master File).

masterFileTarget

List<DocumentReference> masterFileTarget

The actual objects that are the target of the reference (A master file for to the medicinal product (e.g. Pharmacovigilance System Master File).)

name

List<MedicinalProduct.MedicinalProductNameComponent> name

The product's name, including full name and possibly coded parts.

packagedMedicinalProduct

List<Reference> packagedMedicinalProduct

Package representation for the product.

packagedMedicinalProductTarget

List<MedicinalProductPackaged> packagedMedicinalProductTarget

The actual objects that are the target of the reference (Package representation for the product.)

paediatricUseIndicator

CodeableConcept paediatricUseIndicator

If authorised for use in children.

pharmaceuticalProduct

List<Reference> pharmaceuticalProduct

Pharmaceutical aspects of product.

pharmaceuticalProductTarget

List<MedicinalProductPharmaceutical> pharmaceuticalProductTarget

The actual objects that are the target of the reference (Pharmaceutical aspects of product.)

productClassification

List<CodeableConcept> productClassification

Allows the product to be classified by various systems.

specialDesignation

List<MedicinalProduct.MedicinalProductSpecialDesignationComponent> specialDesignation

Indicates if the medicinal product has an orphan designation for the treatment of a rare disease.

specialMeasures

List<StringType> specialMeasures

Whether the Medicinal Product is subject to special measures for regulatory reasons.

type

CodeableConcept type

Regulatory type, e.g. Investigational or Authorized.

Class org.hl7.fhir.r4.model.MedicinalProduct.MedicinalProductManufacturingBusinessOperationComponent

class MedicinalProductManufacturingBusinessOperationComponent extends BackboneElement implements Serializable

serialVersionUID:

1259822353L

Serialized Fields

authorisationReferenceNumber

Identifier authorisationReferenceNumber

Regulatory authorization reference number.

confidentialityIndicator

CodeableConcept confidentialityIndicator

To indicate if this proces is commercially confidential.

effectiveDate

DateTimeType effectiveDate

Regulatory authorization date.

manufacturer

List<Reference> manufacturer

The manufacturer or establishment associated with the process.

manufacturerTarget

List<Organization> manufacturerTarget

The actual objects that are the target of the reference (The manufacturer or establishment associated with the process.)

operationType

CodeableConcept operationType

The type of manufacturing operation.

regulator

Reference regulator

A regulator which oversees the operation.

regulatorTarget

Organization regulatorTarget

The actual object that is the target of the reference (A regulator which oversees the operation.)

Class org.hl7.fhir.r4.model.MedicinalProduct.MedicinalProductNameComponent

class MedicinalProductNameComponent extends BackboneElement implements Serializable

serialVersionUID:

-2005005917L

Serialized Fields

countryLanguage

List<MedicinalProduct.MedicinalProductNameCountryLanguageComponent> countryLanguage

Country where the name applies.

namePart

List<MedicinalProduct.MedicinalProductNameNamePartComponent> namePart

Coding words or phrases of the name.

productName

StringType productName

The full product name.

Class org.hl7.fhir.r4.model.MedicinalProduct.MedicinalProductNameCountryLanguageComponent

class MedicinalProductNameCountryLanguageComponent extends BackboneElement implements Serializable

serialVersionUID:

1627157564L

Serialized Fields

country

CodeableConcept country

Country code for where this name applies.

jurisdiction

CodeableConcept jurisdiction

Jurisdiction code for where this name applies.

language

CodeableConcept language

Language code for this name.

Class org.hl7.fhir.r4.model.MedicinalProduct.MedicinalProductNameNamePartComponent

class MedicinalProductNameNamePartComponent extends BackboneElement implements Serializable

serialVersionUID:

-301533796L

Serialized Fields

part

StringType part

A fragment of a product name.

type

Coding type

Idenifying type for this part of the name (e.g. strength part).

Class org.hl7.fhir.r4.model.MedicinalProduct.MedicinalProductSpecialDesignationComponent

class MedicinalProductSpecialDesignationComponent extends BackboneElement implements Serializable

serialVersionUID:

-1316809207L

Serialized Fields

date

DateTimeType date

Date when the designation was granted.

identifier

List<Identifier> identifier

Identifier for the designation, or procedure number.

indication

Type indication

Condition for which the medicinal use applies.

intendedUse

CodeableConcept intendedUse

The intended use of the product, e.g. prevention, treatment.

species

CodeableConcept species

Animal species for which this applies.

status

CodeableConcept status

For example granted, pending, expired or withdrawn.

type

CodeableConcept type

The type of special designation, e.g. orphan drug, minor use.

Class org.hl7.fhir.r4.model.MedicinalProductAuthorization

class MedicinalProductAuthorization extends DomainResource implements Serializable

serialVersionUID:

16249078L

Serialized Fields

country

List<CodeableConcept> country

The country in which the marketing authorization has been granted.

dataExclusivityPeriod

Period dataExclusivityPeriod

A period of time after authorization before generic product applicatiosn can be submitted.

dateOfFirstAuthorization

DateTimeType dateOfFirstAuthorization

The date when the first authorization was granted by a Medicines Regulatory Agency.

holder

Reference holder

Marketing Authorization Holder.

holderTarget

Organization holderTarget

The actual object that is the target of the reference (Marketing Authorization Holder.)

identifier

List<Identifier> identifier

Business identifier for the marketing authorization, as assigned by a regulator.

internationalBirthDate

DateTimeType internationalBirthDate

Date of first marketing authorization for a company's new medicinal product in any country in the World.

jurisdiction

List<CodeableConcept> jurisdiction

Jurisdiction within a country.

jurisdictionalAuthorization

List<MedicinalProductAuthorization.MedicinalProductAuthorizationJurisdictionalAuthorizationComponent> jurisdictionalAuthorization

Authorization in areas within a country.

legalBasis

CodeableConcept legalBasis

The legal framework against which this authorization is granted.

procedure

MedicinalProductAuthorization.MedicinalProductAuthorizationProcedureComponent procedure

The regulatory procedure for granting or amending a marketing authorization.

regulator

Reference regulator

Medicines Regulatory Agency.

regulatorTarget

Organization regulatorTarget

The actual object that is the target of the reference (Medicines Regulatory Agency.)

restoreDate

DateTimeType restoreDate

The date when a suspended the marketing or the marketing authorization of the product is anticipated to be restored.

status

CodeableConcept status

The status of the marketing authorization.

statusDate

DateTimeType statusDate

The date at which the given status has become applicable.

subject

Reference subject

The medicinal product that is being authorized.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (The medicinal product that is being authorized.)

validityPeriod

Period validityPeriod

The beginning of the time period in which the marketing authorization is in the specific status shall be specified A complete date consisting of day, month and year shall be specified using the ISO 8601 date format.

Class org.hl7.fhir.r4.model.MedicinalProductAuthorization.MedicinalProductAuthorizationJurisdictionalAuthorizationComponent

class MedicinalProductAuthorizationJurisdictionalAuthorizationComponent extends BackboneElement implements Serializable

serialVersionUID:

-1893307291L

Serialized Fields

country

CodeableConcept country

Country of authorization.

identifier

List<Identifier> identifier

The assigned number for the marketing authorization.

jurisdiction

List<CodeableConcept> jurisdiction

Jurisdiction within a country.

legalStatusOfSupply

CodeableConcept legalStatusOfSupply

The legal status of supply in a jurisdiction or region.

validityPeriod

Period validityPeriod

The start and expected end date of the authorization.

Class org.hl7.fhir.r4.model.MedicinalProductAuthorization.MedicinalProductAuthorizationProcedureComponent

class MedicinalProductAuthorizationProcedureComponent extends BackboneElement implements Serializable

serialVersionUID:

930236001L

Serialized Fields

application

List<MedicinalProductAuthorization.MedicinalProductAuthorizationProcedureComponent> application

Applcations submitted to obtain a marketing authorization.

date

Type date

Date of procedure.

identifier

Identifier identifier

Identifier for this procedure.

type

CodeableConcept type

Type of procedure.

Class org.hl7.fhir.r4.model.MedicinalProductContraindication

class MedicinalProductContraindication extends DomainResource implements Serializable

serialVersionUID:

-1746103034L

Serialized Fields

comorbidity

List<CodeableConcept> comorbidity

A comorbidity (concurrent condition) or coinfection.

disease

CodeableConcept disease

The disease, symptom or procedure for the contraindication.

diseaseStatus

CodeableConcept diseaseStatus

The status of the disease or symptom for the contraindication.

otherTherapy

List<MedicinalProductContraindication.MedicinalProductContraindicationOtherTherapyComponent> otherTherapy

Information about the use of the medicinal product in relation to other therapies described as part of the indication.

population

List<Population> population

The population group to which this applies.

subject

List<Reference> subject

The medication for which this is an indication.

subjectTarget

List<Resource> subjectTarget

The actual objects that are the target of the reference (The medication for which this is an indication.)

therapeuticIndication

List<Reference> therapeuticIndication

Information about the use of the medicinal product in relation to other therapies as part of the indication.

therapeuticIndicationTarget

List<MedicinalProductIndication> therapeuticIndicationTarget

The actual objects that are the target of the reference (Information about the use of the medicinal product in relation to other therapies as part of the indication.)

Class org.hl7.fhir.r4.model.MedicinalProductContraindication.MedicinalProductContraindicationOtherTherapyComponent

class MedicinalProductContraindicationOtherTherapyComponent extends BackboneElement implements Serializable

serialVersionUID:

1438478115L

Serialized Fields

medication

Type medication

Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.

therapyRelationshipType

CodeableConcept therapyRelationshipType

The type of relationship between the medicinal product indication or contraindication and another therapy.

Class org.hl7.fhir.r4.model.MedicinalProductIndication

class MedicinalProductIndication extends DomainResource implements Serializable

serialVersionUID:

1205519664L

Serialized Fields

comorbidity

List<CodeableConcept> comorbidity

Comorbidity (concurrent condition) or co-infection as part of the indication.

diseaseStatus

CodeableConcept diseaseStatus

The status of the disease or symptom for which the indication applies.

diseaseSymptomProcedure

CodeableConcept diseaseSymptomProcedure

The disease, symptom or procedure that is the indication for treatment.

duration

Quantity duration

Timing or duration information as part of the indication.

intendedEffect

CodeableConcept intendedEffect

The intended effect, aim or strategy to be achieved by the indication.

otherTherapy

List<MedicinalProductIndication.MedicinalProductIndicationOtherTherapyComponent> otherTherapy

Information about the use of the medicinal product in relation to other therapies described as part of the indication.

population

List<Population> population

The population group to which this applies.

subject

List<Reference> subject

The medication for which this is an indication.

subjectTarget

List<Resource> subjectTarget

The actual objects that are the target of the reference (The medication for which this is an indication.)

undesirableEffect

List<Reference> undesirableEffect

Describe the undesirable effects of the medicinal product.

undesirableEffectTarget

List<MedicinalProductUndesirableEffect> undesirableEffectTarget

The actual objects that are the target of the reference (Describe the undesirable effects of the medicinal product.)

Class org.hl7.fhir.r4.model.MedicinalProductIndication.MedicinalProductIndicationOtherTherapyComponent

class MedicinalProductIndicationOtherTherapyComponent extends BackboneElement implements Serializable

serialVersionUID:

1438478115L

Serialized Fields

medication

Type medication

Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.

therapyRelationshipType

CodeableConcept therapyRelationshipType

The type of relationship between the medicinal product indication or contraindication and another therapy.

Class org.hl7.fhir.r4.model.MedicinalProductIngredient

class MedicinalProductIngredient extends DomainResource implements Serializable

serialVersionUID:

-1454686641L

Serialized Fields

allergenicIndicator

BooleanType allergenicIndicator

If the ingredient is a known or suspected allergen.

identifier

Identifier identifier

The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.

manufacturer

List<Reference> manufacturer

Manufacturer of this Ingredient.

manufacturerTarget

List<Organization> manufacturerTarget

The actual objects that are the target of the reference (Manufacturer of this Ingredient.)

role

CodeableConcept role

Ingredient role e.g. Active ingredient, excipient.

specifiedSubstance

List<MedicinalProductIngredient.MedicinalProductIngredientSpecifiedSubstanceComponent> specifiedSubstance

A specified substance that comprises this ingredient.

substance

MedicinalProductIngredient.MedicinalProductIngredientSubstanceComponent substance

The ingredient substance.

Class org.hl7.fhir.r4.model.MedicinalProductIngredient.MedicinalProductIngredientSpecifiedSubstanceComponent

class MedicinalProductIngredientSpecifiedSubstanceComponent extends BackboneElement implements Serializable

serialVersionUID:

-272590200L

Serialized Fields

code

CodeableConcept code

The specified substance.

confidentiality

CodeableConcept confidentiality

Confidentiality level of the specified substance as the ingredient.

group

CodeableConcept group

The group of specified substance, e.g. group 1 to 4.

strength

List<MedicinalProductIngredient.MedicinalProductIngredientSpecifiedSubstanceStrengthComponent> strength

Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product.

Class org.hl7.fhir.r4.model.MedicinalProductIngredient.MedicinalProductIngredientSpecifiedSubstanceStrengthComponent

class MedicinalProductIngredientSpecifiedSubstanceStrengthComponent extends BackboneElement implements Serializable

serialVersionUID:

1981438822L

Serialized Fields

concentration

Ratio concentration

The strength per unitary volume (or mass).

concentrationLowLimit

Ratio concentrationLowLimit

A lower limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the upper limit.

country

List<CodeableConcept> country

The country or countries for which the strength range applies.

measurementPoint

StringType measurementPoint

For when strength is measured at a particular point or distance.

presentation

Ratio presentation

The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item.

presentationLowLimit

Ratio presentationLowLimit

A lower limit for the quantity of substance in the unit of presentation. For use when there is a range of strengths, this is the lower limit, with the presentation attribute becoming the upper limit.

referenceStrength

List<MedicinalProductIngredient.MedicinalProductIngredientSpecifiedSubstanceStrengthReferenceStrengthComponent> referenceStrength

Strength expressed in terms of a reference substance.

Class org.hl7.fhir.r4.model.MedicinalProductIngredient.MedicinalProductIngredientSpecifiedSubstanceStrengthReferenceStrengthComponent

class MedicinalProductIngredientSpecifiedSubstanceStrengthReferenceStrengthComponent extends BackboneElement implements Serializable

serialVersionUID:

-839485716L

Serialized Fields

country

List<CodeableConcept> country

The country or countries for which the strength range applies.

measurementPoint

StringType measurementPoint

For when strength is measured at a particular point or distance.

strength

Ratio strength

Strength expressed in terms of a reference substance.

strengthLowLimit

Ratio strengthLowLimit

Strength expressed in terms of a reference substance.

substance

CodeableConcept substance

Relevant reference substance.

Class org.hl7.fhir.r4.model.MedicinalProductIngredient.MedicinalProductIngredientSubstanceComponent

class MedicinalProductIngredientSubstanceComponent extends BackboneElement implements Serializable

serialVersionUID:

1325868149L

Serialized Fields

code

CodeableConcept code

The ingredient substance.

strength

List<MedicinalProductIngredient.MedicinalProductIngredientSpecifiedSubstanceStrengthComponent> strength

Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product.

Class org.hl7.fhir.r4.model.MedicinalProductInteraction

class MedicinalProductInteraction extends DomainResource implements Serializable

serialVersionUID:

-1872687169L

Serialized Fields

description

StringType description

The interaction described.

effect

CodeableConcept effect

The effect of the interaction, for example "reduced gastric absorption of primary medication".

incidence

CodeableConcept incidence

The incidence of the interaction, e.g. theoretical, observed.

interactant

List<MedicinalProductInteraction.MedicinalProductInteractionInteractantComponent> interactant

The specific medication, food or laboratory test that interacts.

management

CodeableConcept management

Actions for managing the interaction.

subject

List<Reference> subject

The medication for which this is a described interaction.

subjectTarget

List<Resource> subjectTarget

The actual objects that are the target of the reference (The medication for which this is a described interaction.)

type

CodeableConcept type

The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction.

Class org.hl7.fhir.r4.model.MedicinalProductInteraction.MedicinalProductInteractionInteractantComponent

class MedicinalProductInteractionInteractantComponent extends BackboneElement implements Serializable

serialVersionUID:

1445276561L

Serialized Fields

item

Type item

The specific medication, food or laboratory test that interacts.

Class org.hl7.fhir.r4.model.MedicinalProductManufactured

class MedicinalProductManufactured extends DomainResource implements Serializable

serialVersionUID:

623073384L

Serialized Fields

ingredient

List<Reference> ingredient

Ingredient.

ingredientTarget

List<MedicinalProductIngredient> ingredientTarget

The actual objects that are the target of the reference (Ingredient.)

manufacturedDoseForm

CodeableConcept manufacturedDoseForm

Dose form as manufactured and before any transformation into the pharmaceutical product.

manufacturer

List<Reference> manufacturer

Manufacturer of the item (Note that this should be named "manufacturer" but it currently causes technical issues).

manufacturerTarget

List<Organization> manufacturerTarget

The actual objects that are the target of the reference (Manufacturer of the item (Note that this should be named "manufacturer" but it currently causes technical issues).)

otherCharacteristics

List<CodeableConcept> otherCharacteristics

Other codeable characteristics.

physicalCharacteristics

ProdCharacteristic physicalCharacteristics

Dimensions, color etc.

quantity

Quantity quantity

The quantity or "count number" of the manufactured item.

unitOfPresentation

CodeableConcept unitOfPresentation

The ?real world? units in which the quantity of the manufactured item is described.

Class org.hl7.fhir.r4.model.MedicinalProductPackaged

class MedicinalProductPackaged extends DomainResource implements Serializable

serialVersionUID:

-1530863773L

Serialized Fields

batchIdentifier

List<MedicinalProductPackaged.MedicinalProductPackagedBatchIdentifierComponent> batchIdentifier

Batch numbering.

description

StringType description

Textual description.

identifier

List<Identifier> identifier

Unique identifier.

legalStatusOfSupply

CodeableConcept legalStatusOfSupply

The legal status of supply of the medicinal product as classified by the regulator.

manufacturer

List<Reference> manufacturer

Manufacturer of this Package Item.

manufacturerTarget

List<Organization> manufacturerTarget

The actual objects that are the target of the reference (Manufacturer of this Package Item.)

marketingAuthorization

Reference marketingAuthorization

Manufacturer of this Package Item.

marketingAuthorizationTarget

MedicinalProductAuthorization marketingAuthorizationTarget

The actual object that is the target of the reference (Manufacturer of this Package Item.)

marketingStatus

List<MarketingStatus> marketingStatus

Marketing information.

packageItem

List<MedicinalProductPackaged.MedicinalProductPackagedPackageItemComponent> packageItem

A packaging item, as a contained for medicine, possibly with other packaging items within.

subject

List<Reference> subject

The product with this is a pack for.

subjectTarget

List<MedicinalProduct> subjectTarget

The actual objects that are the target of the reference (The product with this is a pack for.)

Class org.hl7.fhir.r4.model.MedicinalProductPackaged.MedicinalProductPackagedBatchIdentifierComponent

class MedicinalProductPackagedBatchIdentifierComponent extends BackboneElement implements Serializable

serialVersionUID:

1187365068L

Serialized Fields

immediatePackaging

Identifier immediatePackaging

A number appearing on the immediate packaging (and not the outer packaging).

outerPackaging

Identifier outerPackaging

A number appearing on the outer packaging of a specific batch.

Class org.hl7.fhir.r4.model.MedicinalProductPackaged.MedicinalProductPackagedPackageItemComponent

class MedicinalProductPackagedPackageItemComponent extends BackboneElement implements Serializable

serialVersionUID:

1454286533L

Serialized Fields

alternateMaterial

List<CodeableConcept> alternateMaterial

A possible alternate material for the packaging.

device

List<Reference> device

A device accompanying a medicinal product.

deviceTarget

List<DeviceDefinition> deviceTarget

The actual objects that are the target of the reference (A device accompanying a medicinal product.)

identifier

List<Identifier> identifier

Including possibly Data Carrier Identifier.

manufacturedItem

List<Reference> manufacturedItem

The manufactured item as contained in the packaged medicinal product.

manufacturedItemTarget

List<MedicinalProductManufactured> manufacturedItemTarget

The actual objects that are the target of the reference (The manufactured item as contained in the packaged medicinal product.)

manufacturer

List<Reference> manufacturer

Manufacturer of this Package Item.

manufacturerTarget

List<Organization> manufacturerTarget

The actual objects that are the target of the reference (Manufacturer of this Package Item.)

material

List<CodeableConcept> material

Material type of the package item.

otherCharacteristics

List<CodeableConcept> otherCharacteristics

Other codeable characteristics.

packageItem

List<MedicinalProductPackaged.MedicinalProductPackagedPackageItemComponent> packageItem

Allows containers within containers.

physicalCharacteristics

ProdCharacteristic physicalCharacteristics

Dimensions, color etc.

quantity

Quantity quantity

The quantity of this package in the medicinal product, at the current level of packaging. The outermost is always 1.

shelfLifeStorage

List<ProductShelfLife> shelfLifeStorage

Shelf Life and storage information.

type

CodeableConcept type

The physical type of the container of the medicine.

Class org.hl7.fhir.r4.model.MedicinalProductPharmaceutical

class MedicinalProductPharmaceutical extends DomainResource implements Serializable

serialVersionUID:

-1201548050L

Serialized Fields

administrableDoseForm

CodeableConcept administrableDoseForm

The administrable dose form, after necessary reconstitution.

characteristics

List<MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalCharacteristicsComponent> characteristics

Characteristics e.g. a products onset of action.

device

List<Reference> device

Accompanying device.

deviceTarget

List<DeviceDefinition> deviceTarget

The actual objects that are the target of the reference (Accompanying device.)

identifier

List<Identifier> identifier

An identifier for the pharmaceutical medicinal product.

ingredient

List<Reference> ingredient

Ingredient.

ingredientTarget

List<MedicinalProductIngredient> ingredientTarget

The actual objects that are the target of the reference (Ingredient.)

routeOfAdministration

List<MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent> routeOfAdministration

The path by which the pharmaceutical product is taken into or makes contact with the body.

unitOfPresentation

CodeableConcept unitOfPresentation

Todo.

Class org.hl7.fhir.r4.model.MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalCharacteristicsComponent

class MedicinalProductPharmaceuticalCharacteristicsComponent extends BackboneElement implements Serializable

serialVersionUID:

1414556635L

Serialized Fields

code

CodeableConcept code

A coded characteristic.

status

CodeableConcept status

The status of characteristic e.g. assigned or pending.

Class org.hl7.fhir.r4.model.MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent

class MedicinalProductPharmaceuticalRouteOfAdministrationComponent extends BackboneElement implements Serializable

serialVersionUID:

854394783L

Serialized Fields

code

CodeableConcept code

Coded expression for the route.

firstDose

Quantity firstDose

The first dose (dose quantity) administered in humans can be specified, for a product under investigation, using a numerical value and its unit of measurement.

maxDosePerDay

Quantity maxDosePerDay

The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered as per the protocol referenced in the clinical trial authorisation.

maxDosePerTreatmentPeriod

Ratio maxDosePerTreatmentPeriod

The maximum dose per treatment period that can be administered as per the protocol referenced in the clinical trial authorisation.

maxSingleDose

Quantity maxSingleDose

The maximum single dose that can be administered as per the protocol of a clinical trial can be specified using a numerical value and its unit of measurement.

maxTreatmentPeriod

Duration maxTreatmentPeriod

The maximum treatment period during which an Investigational Medicinal Product can be administered as per the protocol referenced in the clinical trial authorisation.

targetSpecies

List<MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesComponent> targetSpecies

A species for which this route applies.

Class org.hl7.fhir.r4.model.MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesComponent

class MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesComponent extends BackboneElement implements Serializable

serialVersionUID:

-664052812L

Serialized Fields

code

CodeableConcept code

Coded expression for the species.

withdrawalPeriod

List<MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesWithdrawalPeriodComponent> withdrawalPeriod

A species specific time during which consumption of animal product is not appropriate.

Class org.hl7.fhir.r4.model.MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesWithdrawalPeriodComponent

class MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesWithdrawalPeriodComponent extends BackboneElement implements Serializable

serialVersionUID:

-1113691238L

Serialized Fields

supportingInformation

StringType supportingInformation

Extra information about the withdrawal period.

tissue

CodeableConcept tissue

Coded expression for the type of tissue for which the withdrawal period applues, e.g. meat, milk.

value

Quantity value

A value for the time.

Class org.hl7.fhir.r4.model.MedicinalProductUndesirableEffect

class MedicinalProductUndesirableEffect extends DomainResource implements Serializable

serialVersionUID:

-1960253956L

Serialized Fields

classification

CodeableConcept classification

Classification of the effect.

frequencyOfOccurrence

CodeableConcept frequencyOfOccurrence

The frequency of occurrence of the effect.

population

List<Population> population

The population group to which this applies.

subject

List<Reference> subject

The medication for which this is an indication.

subjectTarget

List<Resource> subjectTarget

The actual objects that are the target of the reference (The medication for which this is an indication.)

symptomConditionEffect

CodeableConcept symptomConditionEffect

The symptom, condition or undesirable effect.

Class org.hl7.fhir.r4.model.MessageDefinition

class MessageDefinition extends MetadataResource implements Serializable

serialVersionUID:

927775347L

Serialized Fields

allowedResponse

List<MessageDefinition.MessageDefinitionAllowedResponseComponent> allowedResponse

Indicates what types of messages may be sent as an application-level response to this message.

base

CanonicalType base

The MessageDefinition that is the basis for the contents of this resource.

category

Enumeration<MessageDefinition.MessageSignificanceCategory> category

The impact of the content of the message.

copyright

MarkdownType copyright

A copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition.

event

Type event

Event code or link to the EventDefinition.

focus

List<MessageDefinition.MessageDefinitionFocusComponent> focus

Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.

graph

List<CanonicalType> graph

Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a [[[GraphDefinition]]] that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources.

identifier

List<Identifier> identifier

A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

parent

List<CanonicalType> parent

Identifies a protocol or workflow that this MessageDefinition represents a step in.

purpose

MarkdownType purpose

Explanation of why this message definition is needed and why it has been designed as it has.

replaces

List<CanonicalType> replaces

A MessageDefinition that is superseded by this definition.

responseRequired

Enumeration<MessageDefinition.MessageheaderResponseRequest> responseRequired

Declare at a message definition level whether a response is required or only upon error or success, or never.

Class org.hl7.fhir.r4.model.MessageDefinition.MessageDefinitionAllowedResponseComponent

class MessageDefinitionAllowedResponseComponent extends BackboneElement implements Serializable

serialVersionUID:

-1943810550L

Serialized Fields

message

CanonicalType message

A reference to the message definition that must be adhered to by this supported response.

situation

MarkdownType situation

Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses).

Class org.hl7.fhir.r4.model.MessageDefinition.MessageDefinitionFocusComponent

class MessageDefinitionFocusComponent extends BackboneElement implements Serializable

serialVersionUID:

-68504836L

Serialized Fields

code

CodeType code

The kind of resource that must be the focus for this message.

max

StringType max

Identifies the maximum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.

min

UnsignedIntType min

Identifies the minimum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.

profile

CanonicalType profile

A profile that reflects constraints for the focal resource (and potentially for related resources).

Class org.hl7.fhir.r4.model.MessageDefinition.MessageheaderResponseRequestEnumFactory

class MessageheaderResponseRequestEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.MessageDefinition.MessageSignificanceCategoryEnumFactory

class MessageSignificanceCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.MessageHeader

class MessageHeader extends DomainResource implements Serializable

serialVersionUID:

-1039408819L

Serialized Fields

author

Reference author

The logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.

authorTarget

Resource authorTarget

The actual object that is the target of the reference (The logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.)

definition

CanonicalType definition

Permanent link to the MessageDefinition for this message.

destination

List<MessageHeader.MessageDestinationComponent> destination

The destination application which the message is intended for.

enterer

Reference enterer

The person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.

entererTarget

Resource entererTarget

The actual object that is the target of the reference (The person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.)

event

Type event

Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition.

focus

List<Reference> focus

The actual data of the message - a reference to the root/focus class of the event.

focusTarget

List<Resource> focusTarget

The actual objects that are the target of the reference (The actual data of the message - a reference to the root/focus class of the event.)

reason

CodeableConcept reason

Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.

response

MessageHeader.MessageHeaderResponseComponent response

Information about the message that this message is a response to. Only present if this message is a response.

responsible

Reference responsible

The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.

responsibleTarget

Resource responsibleTarget

The actual object that is the target of the reference (The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.)

sender

Reference sender

Identifies the sending system to allow the use of a trust relationship.

senderTarget

Resource senderTarget

The actual object that is the target of the reference (Identifies the sending system to allow the use of a trust relationship.)

source

MessageHeader.MessageSourceComponent source

The source application from which this message originated.

Class org.hl7.fhir.r4.model.MessageHeader.MessageDestinationComponent

class MessageDestinationComponent extends BackboneElement implements Serializable

serialVersionUID:

611064500L

Serialized Fields

endpoint

UrlType endpoint

Indicates where the message should be routed to.

name

StringType name

Human-readable name for the target system.

receiver

Reference receiver

Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.

receiverTarget

Resource receiverTarget

The actual object that is the target of the reference (Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.)

target

Reference target

Identifies the target end system in situations where the initial message transmission is to an intermediary system.

targetTarget

Device targetTarget

The actual object that is the target of the reference (Identifies the target end system in situations where the initial message transmission is to an intermediary system.)

Class org.hl7.fhir.r4.model.MessageHeader.MessageHeaderResponseComponent

class MessageHeaderResponseComponent extends BackboneElement implements Serializable

serialVersionUID:

-1008716838L

Serialized Fields

code

Enumeration<MessageHeader.ResponseType> code

Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.

details

Reference details

Full details of any issues found in the message.

detailsTarget

OperationOutcome detailsTarget

The actual object that is the target of the reference (Full details of any issues found in the message.)

identifier

IdType identifier

The MessageHeader.id of the message to which this message is a response.

Class org.hl7.fhir.r4.model.MessageHeader.MessageSourceComponent

class MessageSourceComponent extends BackboneElement implements Serializable

serialVersionUID:

-350916401L

Serialized Fields

contact

ContactPoint contact

An e-mail, phone, website or other contact point to use to resolve issues with message communications.

endpoint

UrlType endpoint

Identifies the routing target to send acknowledgements to.

name

StringType name

Human-readable name for the source system.

software

StringType software

May include configuration or other information useful in debugging.

version

StringType version

Can convey versions of multiple systems in situations where a message passes through multiple hands.

Class org.hl7.fhir.r4.model.MessageHeader.ResponseTypeEnumFactory

class ResponseTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Meta

class Meta extends Type implements Serializable

serialVersionUID:

-1386695622L

Serialized Fields

lastUpdated

InstantType lastUpdated

When the resource last changed - e.g. when the version changed.

profile

List<CanonicalType> profile

A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].

security

List<Coding> security

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

source

UriType source

A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

tag

List<Coding> tag

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

versionId

IdType versionId

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Class org.hl7.fhir.r4.model.MetadataResource

class MetadataResource extends DomainResource implements Serializable

serialVersionUID:

1952104592L

Serialized Fields

contact

List<ContactDetail> contact

Contact details to assist a user in finding and communicating with the publisher.

date

DateTimeType date

The date (and optionally time) when the metadata resource was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the metadata resource changes.

description

MarkdownType description

A free text natural language description of the metadata resource from a consumer's perspective.

experimental

BooleanType experimental

A Boolean value to indicate that this metadata resource is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

jurisdiction

List<CodeableConcept> jurisdiction

A legal or geographic region in which the metadata resource is intended to be used.

name

StringType name

A natural language name identifying the metadata resource. This name should be usable as an identifier for the module by machine processing applications such as code generation.

publisher

StringType publisher

The name of the organization or individual that published the metadata resource.

status

Enumeration<Enumerations.PublicationStatus> status

The status of this metadata resource. Enables tracking the life-cycle of the content.

title

StringType title

A short, descriptive, user-friendly title for the metadata resource.

url

UriType url

An absolute URI that is used to identify this metadata resource when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this metadata resource is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the metadata resource is stored on different servers.

useContext

List<UsageContext> useContext

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate metadata resource instances.

version

StringType version

The identifier that is used to identify this version of the metadata resource when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the metadata resource author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

Class org.hl7.fhir.r4.model.MolecularSequence

class MolecularSequence extends DomainResource implements Serializable

serialVersionUID:

-1541133500L

Serialized Fields

coordinateSystem

IntegerType coordinateSystem

Whether the sequence is numbered starting at 0 (0-based numbering or coordinates, inclusive start, exclusive end) or starting at 1 (1-based numbering, inclusive start and inclusive end).

device

Reference device

The method for sequencing, for example, chip information.

deviceTarget

Device deviceTarget

The actual object that is the target of the reference (The method for sequencing, for example, chip information.)

identifier

List<Identifier> identifier

A unique identifier for this particular sequence instance. This is a FHIR-defined id.

observedSeq

StringType observedSeq

Sequence that was observed. It is the result marked by referenceSeq along with variant records on referenceSeq. This shall start from referenceSeq.windowStart and end by referenceSeq.windowEnd.

patient

Reference patient

The patient whose sequencing results are described by this resource.

patientTarget

Patient patientTarget

The actual object that is the target of the reference (The patient whose sequencing results are described by this resource.)

performer

Reference performer

The organization or lab that should be responsible for this result.

performerTarget

Organization performerTarget

The actual object that is the target of the reference (The organization or lab that should be responsible for this result.)

pointer

List<Reference> pointer

Pointer to next atomic sequence which at most contains one variant.

pointerTarget

List<MolecularSequence> pointerTarget

The actual objects that are the target of the reference (Pointer to next atomic sequence which at most contains one variant.)

quality

List<MolecularSequence.MolecularSequenceQualityComponent> quality

An experimental feature attribute that defines the quality of the feature in a quantitative way, such as a phred quality score ([SO:0001686](http://www.sequenceontology.org/browser/current_svn/term/SO:0001686)).

quantity

Quantity quantity

The number of copies of the sequence of interest. (RNASeq).

readCoverage

IntegerType readCoverage

Coverage (read depth or depth) is the average number of reads representing a given nucleotide in the reconstructed sequence.

referenceSeq

MolecularSequence.MolecularSequenceReferenceSeqComponent referenceSeq

A sequence that is used as a reference to describe variants that are present in a sequence analyzed.

repository

List<MolecularSequence.MolecularSequenceRepositoryComponent> repository

Configurations of the external repository. The repository shall store target's observedSeq or records related with target's observedSeq.

specimen

Reference specimen

Specimen used for sequencing.

specimenTarget

Specimen specimenTarget

The actual object that is the target of the reference (Specimen used for sequencing.)

structureVariant

List<MolecularSequence.MolecularSequenceStructureVariantComponent> structureVariant

Information about chromosome structure variation.

type

Enumeration<MolecularSequence.SequenceType> type

Amino Acid Sequence/ DNA Sequence / RNA Sequence.

variant

List<MolecularSequence.MolecularSequenceVariantComponent> variant

The definition of variant here originates from Sequence ontology ([variant_of](http://www.sequenceontology.org/browser/current_svn/term/variant_of)). This element can represent amino acid or nucleic sequence change(including insertion,deletion,SNP,etc.) It can represent some complex mutation or segment variation with the assist of CIGAR string.

Class org.hl7.fhir.r4.model.MolecularSequence.MolecularSequenceQualityComponent

class MolecularSequenceQualityComponent extends BackboneElement implements Serializable

serialVersionUID:

-811933526L

Serialized Fields

end

IntegerType end

End position of the sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.

fScore

DecimalType fScore

Harmonic mean of Recall and Precision, computed as: 2 * precision * recall / (precision + recall).

gtFP

DecimalType gtFP

The number of false positives where the non-REF alleles in the Truth and Query Call Sets match (i.e. cases where the truth is 1/1 and the query is 0/1 or similar).

method

CodeableConcept method

Which method is used to get sequence quality.

precision

DecimalType precision

QUERY.TP / (QUERY.TP + QUERY.FP).

queryFP

DecimalType queryFP

False positives, i.e. the number of sites in the Query Call Set for which there is no path through the Truth Call Set that is consistent with this site. Sites with correct variant but incorrect genotype are counted here.

queryTP

DecimalType queryTP

True positives, from the perspective of the query data, i.e. the number of sites in the Query Call Set for which there are paths through the Truth Call Set that are consistent with all of the alleles at this site, and for which there is an accurate genotype call for the event.

recall

DecimalType recall

TRUTH.TP / (TRUTH.TP + TRUTH.FN).

roc

MolecularSequence.MolecularSequenceQualityRocComponent roc

Receiver Operator Characteristic (ROC) Curve to give sensitivity/specificity tradeoff.

score

Quantity score

The score of an experimentally derived feature such as a p-value ([SO:0001685](http://www.sequenceontology.org/browser/current_svn/term/SO:0001685)).

standardSequence

CodeableConcept standardSequence

Gold standard sequence used for comparing against.

start

IntegerType start

Start position of the sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.

truthFN

DecimalType truthFN

False negatives, i.e. the number of sites in the Truth Call Set for which there is no path through the Query Call Set that is consistent with all of the alleles at this site, or sites for which there is an inaccurate genotype call for the event. Sites with correct variant but incorrect genotype are counted here.

truthTP

DecimalType truthTP

True positives, from the perspective of the truth data, i.e. the number of sites in the Truth Call Set for which there are paths through the Query Call Set that are consistent with all of the alleles at this site, and for which there is an accurate genotype call for the event.

type

Enumeration<MolecularSequence.QualityType> type

INDEL / SNP / Undefined variant.

Class org.hl7.fhir.r4.model.MolecularSequence.MolecularSequenceQualityRocComponent

class MolecularSequenceQualityRocComponent extends BackboneElement implements Serializable

serialVersionUID:

1923392132L

Serialized Fields

fMeasure

List<DecimalType> fMeasure

Calculated fScore if the GQ score threshold was set to "score" field value.

numFN

List<IntegerType> numFN

The number of false negatives if the GQ score threshold was set to "score" field value.

numFP

List<IntegerType> numFP

The number of false positives if the GQ score threshold was set to "score" field value.

numTP

List<IntegerType> numTP

The number of true positives if the GQ score threshold was set to "score" field value.

precision

List<DecimalType> precision

Calculated precision if the GQ score threshold was set to "score" field value.

score

List<IntegerType> score

Invidual data point representing the GQ (genotype quality) score threshold.

sensitivity

List<DecimalType> sensitivity

Calculated sensitivity if the GQ score threshold was set to "score" field value.

Class org.hl7.fhir.r4.model.MolecularSequence.MolecularSequenceReferenceSeqComponent

class MolecularSequenceReferenceSeqComponent extends BackboneElement implements Serializable

serialVersionUID:

307364267L

Serialized Fields

chromosome

CodeableConcept chromosome

Structural unit composed of a nucleic acid molecule which controls its own replication through the interaction of specific proteins at one or more origins of replication ([SO:0000340](http://www.sequenceontology.org/browser/current_svn/term/SO:0000340)).

genomeBuild

StringType genomeBuild

The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37'. Version number must be included if a versioned release of a primary build was used.

orientation

Enumeration<MolecularSequence.OrientationType> orientation

A relative reference to a DNA strand based on gene orientation. The strand that contains the open reading frame of the gene is the "sense" strand, and the opposite complementary strand is the "antisense" strand.

referenceSeqId

CodeableConcept referenceSeqId

Reference identifier of reference sequence submitted to NCBI. It must match the type in the MolecularSequence.type field. For example, the prefix, ?NG_? identifies reference sequence for genes, ?NM_? for messenger RNA transcripts, and ?NP_? for amino acid sequences.

referenceSeqPointer

Reference referenceSeqPointer

A pointer to another MolecularSequence entity as reference sequence.

referenceSeqPointerTarget

MolecularSequence referenceSeqPointerTarget

The actual object that is the target of the reference (A pointer to another MolecularSequence entity as reference sequence.)

referenceSeqString

StringType referenceSeqString

A string like "ACGT".

strand

Enumeration<MolecularSequence.StrandType> strand

An absolute reference to a strand. The Watson strand is the strand whose 5'-end is on the short arm of the chromosome, and the Crick strand as the one whose 5'-end is on the long arm.

windowEnd

IntegerType windowEnd

End position of the window on the reference sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.

windowStart

IntegerType windowStart

Start position of the window on the reference sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.

Class org.hl7.fhir.r4.model.MolecularSequence.MolecularSequenceRepositoryComponent

class MolecularSequenceRepositoryComponent extends BackboneElement implements Serializable

serialVersionUID:

-899243265L

Serialized Fields

datasetId

StringType datasetId

Id of the variant in this external repository. The server will understand how to use this id to call for more info about datasets in external repository.

name

StringType name

URI of an external repository which contains further details about the genetics data.

readsetId

StringType readsetId

Id of the read in this external repository.

type

Enumeration<MolecularSequence.RepositoryType> type

Click and see / RESTful API / Need login to see / RESTful API with authentication / Other ways to see resource.

url

UriType url

URI of an external repository which contains further details about the genetics data.

variantsetId

StringType variantsetId

Id of the variantset in this external repository. The server will understand how to use this id to call for more info about variantsets in external repository.

Class org.hl7.fhir.r4.model.MolecularSequence.MolecularSequenceStructureVariantComponent

class MolecularSequenceStructureVariantComponent extends BackboneElement implements Serializable

serialVersionUID:

-1943515207L

Serialized Fields

exact

BooleanType exact

Used to indicate if the outer and inner start-end values have the same meaning.

inner

MolecularSequence.MolecularSequenceStructureVariantInnerComponent inner

Structural variant inner.

length

IntegerType length

Length of the variant chromosome.

outer

MolecularSequence.MolecularSequenceStructureVariantOuterComponent outer

Structural variant outer.

variantType

CodeableConcept variantType

Information about chromosome structure variation DNA change type.

Class org.hl7.fhir.r4.model.MolecularSequence.MolecularSequenceStructureVariantInnerComponent

class MolecularSequenceStructureVariantInnerComponent extends BackboneElement implements Serializable

serialVersionUID:

-1798864889L

Serialized Fields

end

IntegerType end

Structural variant inner end. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.

start

IntegerType start

Structural variant inner start. If the coordinate system is either 0-based or 1-based, then start position is inclusive.

Class org.hl7.fhir.r4.model.MolecularSequence.MolecularSequenceStructureVariantOuterComponent

class MolecularSequenceStructureVariantOuterComponent extends BackboneElement implements Serializable

serialVersionUID:

-1798864889L

Serialized Fields

end

IntegerType end

Structural variant outer end. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.

start

IntegerType start

Structural variant outer start. If the coordinate system is either 0-based or 1-based, then start position is inclusive.

Class org.hl7.fhir.r4.model.MolecularSequence.MolecularSequenceVariantComponent

class MolecularSequenceVariantComponent extends BackboneElement implements Serializable

serialVersionUID:

105611837L

Serialized Fields

cigar

StringType cigar

Extended CIGAR string for aligning the sequence with reference bases. See detailed documentation [here](http://support.illumina.com/help/SequencingAnalysisWorkflow/Content/Vault/Informatics/Sequencing_Analysis/CASAVA/swSEQ_mCA_ExtendedCIGARFormat.htm).

end

IntegerType end

End position of the variant on the reference sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.

observedAllele

StringType observedAllele

An allele is one of a set of coexisting sequence variants of a gene ([SO:0001023](http://www.sequenceontology.org/browser/current_svn/term/SO:0001023)). Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the observed sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end.

referenceAllele

StringType referenceAllele

An allele is one of a set of coexisting sequence variants of a gene ([SO:0001023](http://www.sequenceontology.org/browser/current_svn/term/SO:0001023)). Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the reference sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end.

start

IntegerType start

Start position of the variant on the reference sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.

variantPointer

Reference variantPointer

A pointer to an Observation containing variant information.

variantPointerTarget

Observation variantPointerTarget

The actual object that is the target of the reference (A pointer to an Observation containing variant information.)

Class org.hl7.fhir.r4.model.MolecularSequence.OrientationTypeEnumFactory

class OrientationTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.MolecularSequence.QualityTypeEnumFactory

class QualityTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.MolecularSequence.RepositoryTypeEnumFactory

class RepositoryTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.MolecularSequence.SequenceTypeEnumFactory

class SequenceTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.MolecularSequence.StrandTypeEnumFactory

class StrandTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Money

class Money extends Type implements Serializable

serialVersionUID:

-484637938L

Serialized Fields

currency

CodeType currency

ISO 4217 Currency Code.

value

DecimalType value

Numerical value (with implicit precision).

Class org.hl7.fhir.r4.model.MoneyQuantity

class MoneyQuantity extends Quantity implements Serializable

serialVersionUID:

1069574054L

Class org.hl7.fhir.r4.model.NamingSystem

class NamingSystem extends MetadataResource implements Serializable

serialVersionUID:

1686086580L

Serialized Fields

kind

Enumeration<NamingSystem.NamingSystemType> kind

Indicates the purpose for the naming system - what kinds of things does it make unique?

responsible

StringType responsible

The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.

type

CodeableConcept type

Categorizes a naming system for easier search by grouping related naming systems.

uniqueId

List<NamingSystem.NamingSystemUniqueIdComponent> uniqueId

Indicates how the system may be identified when referenced in electronic exchange.

usage

StringType usage

Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.

Class org.hl7.fhir.r4.model.NamingSystem.NamingSystemIdentifierTypeEnumFactory

class NamingSystemIdentifierTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.NamingSystem.NamingSystemTypeEnumFactory

class NamingSystemTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.NamingSystem.NamingSystemUniqueIdComponent

class NamingSystemUniqueIdComponent extends BackboneElement implements Serializable

serialVersionUID:

-1458889328L

Serialized Fields

comment

StringType comment

Notes about the past or intended usage of this identifier.

period

Period period

Identifies the period of time over which this identifier is considered appropriate to refer to the naming system. Outside of this window, the identifier might be non-deterministic.

preferred

BooleanType preferred

Indicates whether this identifier is the "preferred" identifier of this type.

type

Enumeration<NamingSystem.NamingSystemIdentifierType> type

Identifies the unique identifier scheme used for this particular identifier.

value

StringType value

The string that should be sent over the wire to identify the code system or identifier system.

Class org.hl7.fhir.r4.model.Narrative

class Narrative extends BaseNarrative implements Serializable

serialVersionUID:

1463852859L

Serialized Fields

div

org.hl7.fhir.utilities.xhtml.XhtmlNode div

The actual narrative content, a stripped down version of XHTML.

status

Enumeration<Narrative.NarrativeStatus> status

The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

Class org.hl7.fhir.r4.model.Narrative.NarrativeStatusEnumFactory

class NarrativeStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.NutritionOrder

class NutritionOrder extends DomainResource implements Serializable

serialVersionUID:

1746744267L

Serialized Fields

allergyIntolerance

List<Reference> allergyIntolerance

A link to a record of allergies or intolerances which should be included in the nutrition order.

allergyIntoleranceTarget

List<AllergyIntolerance> allergyIntoleranceTarget

The actual objects that are the target of the reference (A link to a record of allergies or intolerances which should be included in the nutrition order.)

dateTime

DateTimeType dateTime

The date and time that this nutrition order was requested.

encounter

Reference encounter

An encounter that provides additional information about the healthcare context in which this request is made.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (An encounter that provides additional information about the healthcare context in which this request is made.)

enteralFormula

NutritionOrder.NutritionOrderEnteralFormulaComponent enteralFormula

Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.

excludeFoodModifier

List<CodeableConcept> excludeFoodModifier

This modifier is used to convey Order-specific modifier about the type of oral food or oral fluids that should not be given. These can be derived from patient allergies, intolerances, or preferences such as No Red Meat, No Soy or No Wheat or Gluten-Free. While it should not be necessary to repeat allergy or intolerance information captured in the referenced AllergyIntolerance resource in the excludeFoodModifier, this element may be used to convey additional specificity related to foods that should be eliminated from the patient?s diet for any reason. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.

foodPreferenceModifier

List<CodeableConcept> foodPreferenceModifier

This modifier is used to convey order-specific modifiers about the type of food that should be given. These can be derived from patient allergies, intolerances, or preferences such as Halal, Vegan or Kosher. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.

identifier

List<Identifier> identifier

Identifiers assigned to this order by the order sender or by the order receiver.

instantiates

List<UriType> instantiates

The URL pointing to a protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.

instantiatesCanonical

List<CanonicalType> instantiatesCanonical

The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.

instantiatesUri

List<UriType> instantiatesUri

The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.

intent

Enumeration<NutritionOrder.NutritiionOrderIntent> intent

Indicates the level of authority/intentionality associated with the NutrionOrder and where the request fits into the workflow chain.

note

List<Annotation> note

Comments made about the {{title}} by the requester, performer, subject or other participants.

oralDiet

NutritionOrder.NutritionOrderOralDietComponent oralDiet

Diet given orally in contrast to enteral (tube) feeding.

orderer

Reference orderer

The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.

ordererTarget

Resource ordererTarget

The actual object that is the target of the reference (The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.)

patient

Reference patient

The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.

patientTarget

Patient patientTarget

The actual object that is the target of the reference (The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.)

status

Enumeration<NutritionOrder.NutritionOrderStatus> status

The workflow status of the nutrition order/request.

supplement

List<NutritionOrder.NutritionOrderSupplementComponent> supplement

Oral nutritional products given in order to add further nutritional value to the patient's diet.

Class org.hl7.fhir.r4.model.NutritionOrder.NutritiionOrderIntentEnumFactory

class NutritiionOrderIntentEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.NutritionOrder.NutritionOrderEnteralFormulaAdministrationComponent

class NutritionOrderEnteralFormulaAdministrationComponent extends BackboneElement implements Serializable

serialVersionUID:

673093291L

Serialized Fields

quantity

Quantity quantity

The volume of formula to provide to the patient per the specified administration schedule.

rate

Type rate

The rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule.

schedule

Timing schedule

The time period and frequency at which the enteral formula should be delivered to the patient.

Class org.hl7.fhir.r4.model.NutritionOrder.NutritionOrderEnteralFormulaComponent

class NutritionOrderEnteralFormulaComponent extends BackboneElement implements Serializable

serialVersionUID:

-124511395L

Serialized Fields

additiveProductName

StringType additiveProductName

The product or brand name of the type of modular component to be added to the formula.

additiveType

CodeableConcept additiveType

Indicates the type of modular component such as protein, carbohydrate, fat or fiber to be provided in addition to or mixed with the base formula.

administration

List<NutritionOrder.NutritionOrderEnteralFormulaAdministrationComponent> administration

Formula administration instructions as structured data. This repeating structure allows for changing the administration rate or volume over time for both bolus and continuous feeding. An example of this would be an instruction to increase the rate of continuous feeding every 2 hours.

administrationInstruction

StringType administrationInstruction

Free text formula administration, feeding instructions or additional instructions or information.

baseFormulaProductName

StringType baseFormulaProductName

The product or brand name of the enteral or infant formula product such as "ACME Adult Standard Formula".

baseFormulaType

CodeableConcept baseFormulaType

The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.

caloricDensity

Quantity caloricDensity

The amount of energy (calories) that the formula should provide per specified volume, typically per mL or fluid oz. For example, an infant may require a formula that provides 24 calories per fluid ounce or an adult may require an enteral formula that provides 1.5 calorie/mL.

maxVolumeToDeliver

Quantity maxVolumeToDeliver

The maximum total quantity of formula that may be administered to a subject over the period of time, e.g. 1440 mL over 24 hours.

routeofAdministration

CodeableConcept routeofAdministration

The route or physiological path of administration into the patient's gastrointestinal tract for purposes of providing the formula feeding, e.g. nasogastric tube.

Class org.hl7.fhir.r4.model.NutritionOrder.NutritionOrderOralDietComponent

class NutritionOrderOralDietComponent extends BackboneElement implements Serializable

serialVersionUID:

973058412L

Serialized Fields

fluidConsistencyType

List<CodeableConcept> fluidConsistencyType

The required consistency (e.g. honey-thick, nectar-thick, thin, thickened.) of liquids or fluids served to the patient.

instruction

StringType instruction

Free text or additional instructions or information pertaining to the oral diet.

nutrient

List<NutritionOrder.NutritionOrderOralDietNutrientComponent> nutrient

Class that defines the quantity and type of nutrient modifications (for example carbohydrate, fiber or sodium) required for the oral diet.

schedule

List<Timing> schedule

The time period and frequency at which the diet should be given. The diet should be given for the combination of all schedules if more than one schedule is present.

texture

List<NutritionOrder.NutritionOrderOralDietTextureComponent> texture

Class that describes any texture modifications required for the patient to safely consume various types of solid foods.

type

List<CodeableConcept> type

The kind of diet or dietary restriction such as fiber restricted diet or diabetic diet.

Class org.hl7.fhir.r4.model.NutritionOrder.NutritionOrderOralDietNutrientComponent

class NutritionOrderOralDietNutrientComponent extends BackboneElement implements Serializable

serialVersionUID:

1042462093L

Serialized Fields

amount

Quantity amount

The quantity of the specified nutrient to include in diet.

modifier

CodeableConcept modifier

The nutrient that is being modified such as carbohydrate or sodium.

Class org.hl7.fhir.r4.model.NutritionOrder.NutritionOrderOralDietTextureComponent

class NutritionOrderOralDietTextureComponent extends BackboneElement implements Serializable

serialVersionUID:

-56402817L

Serialized Fields

foodType

CodeableConcept foodType

The food type(s) (e.g. meats, all foods) that the texture modification applies to. This could be all foods types.

modifier

CodeableConcept modifier

Any texture modifications (for solid foods) that should be made, e.g. easy to chew, chopped, ground, and pureed.

Class org.hl7.fhir.r4.model.NutritionOrder.NutritionOrderStatusEnumFactory

class NutritionOrderStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.NutritionOrder.NutritionOrderSupplementComponent

class NutritionOrderSupplementComponent extends BackboneElement implements Serializable

serialVersionUID:

-37646618L

Serialized Fields

instruction

StringType instruction

Free text or additional instructions or information pertaining to the oral supplement.

productName

StringType productName

The product or brand name of the nutritional supplement such as "Acme Protein Shake".

quantity

Quantity quantity

The amount of the nutritional supplement to be given.

schedule

List<Timing> schedule

The time period and frequency at which the supplement(s) should be given. The supplement should be given for the combination of all schedules if more than one schedule is present.

type

CodeableConcept type

The kind of nutritional supplement product required such as a high protein or pediatric clear liquid supplement.

Class org.hl7.fhir.r4.model.Observation

class Observation extends DomainResource implements Serializable

serialVersionUID:

-2036786355L

Serialized Fields

basedOn

List<Reference> basedOn

A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.

basedOnTarget

List<Resource> basedOnTarget

The actual objects that are the target of the reference (A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.)

bodySite

CodeableConcept bodySite

Indicates the site on the subject's body where the observation was made (i.e. the target site).

category

List<CodeableConcept> category

A code that classifies the general type of observation being made.

code

CodeableConcept code

Describes what was observed. Sometimes this is called the observation "name".

component

List<Observation.ObservationComponentComponent> component

Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.

dataAbsentReason

CodeableConcept dataAbsentReason

Provides a reason why the expected value in the element Observation.value[x] is missing.

derivedFrom

List<Reference> derivedFrom

The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.

derivedFromTarget

List<Resource> derivedFromTarget

The actual objects that are the target of the reference (The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.)

device

Reference device

The device used to generate the observation data.

deviceTarget

Resource deviceTarget

The actual object that is the target of the reference (The device used to generate the observation data.)

effective

Type effective

The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.

encounter

Reference encounter

The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.)

focus

List<Reference> focus

The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.

focusTarget

List<Resource> focusTarget

The actual objects that are the target of the reference (The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.)

hasMember

List<Reference> hasMember

This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.

hasMemberTarget

List<Resource> hasMemberTarget

The actual objects that are the target of the reference (This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.)

identifier

List<Identifier> identifier

A unique identifier assigned to this observation.

interpretation

List<CodeableConcept> interpretation

A categorical assessment of an observation value. For example, high, low, normal.

issued

InstantType issued

The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.

method

CodeableConcept method

Indicates the mechanism used to perform the observation.

note

List<Annotation> note

Comments about the observation or the results.

partOf

List<Reference> partOf

A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.

partOfTarget

List<Resource> partOfTarget

The actual objects that are the target of the reference (A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.)

performer

List<Reference> performer

Who was responsible for asserting the observed value as "true".

performerTarget

List<Resource> performerTarget

The actual objects that are the target of the reference (Who was responsible for asserting the observed value as "true".)

referenceRange

List<Observation.ObservationReferenceRangeComponent> referenceRange

Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.

specimen

Reference specimen

The specimen that was used when this observation was made.

specimenTarget

Specimen specimenTarget

The actual object that is the target of the reference (The specimen that was used when this observation was made.)

status

Enumeration<Observation.ObservationStatus> status

The status of the result value.

subject

Reference subject

The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation.)

value

Type value

The information determined as a result of making the observation, if the information has a simple value.

Class org.hl7.fhir.r4.model.Observation.ObservationComponentComponent

class ObservationComponentComponent extends BackboneElement implements Serializable

serialVersionUID:

576590931L

Serialized Fields

code

CodeableConcept code

Describes what was observed. Sometimes this is called the observation "code".

dataAbsentReason

CodeableConcept dataAbsentReason

Provides a reason why the expected value in the element Observation.component.value[x] is missing.

interpretation

List<CodeableConcept> interpretation

A categorical assessment of an observation value. For example, high, low, normal.

referenceRange

List<Observation.ObservationReferenceRangeComponent> referenceRange

Guidance on how to interpret the value by comparison to a normal or recommended range.

value

Type value

The information determined as a result of making the observation, if the information has a simple value.

Class org.hl7.fhir.r4.model.Observation.ObservationReferenceRangeComponent

class ObservationReferenceRangeComponent extends BackboneElement implements Serializable

serialVersionUID:

-305128879L

Serialized Fields

age

Range age

The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.

appliesTo

List<CodeableConcept> appliesTo

Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

high

Quantity high

The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - invalid input: '<'=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).

low

Quantity low

The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - invalid input: '<'=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is invalid input: '<'=2.3).

text

StringType text

Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".

type

CodeableConcept type

Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

Class org.hl7.fhir.r4.model.Observation.ObservationStatusEnumFactory

class ObservationStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ObservationDefinition

class ObservationDefinition extends DomainResource implements Serializable

serialVersionUID:

2136752757L

Serialized Fields

abnormalCodedValueSet

Reference abnormalCodedValueSet

The set of abnormal coded results for the observation conforming to this ObservationDefinition.

abnormalCodedValueSetTarget

ValueSet abnormalCodedValueSetTarget

The actual object that is the target of the reference (The set of abnormal coded results for the observation conforming to this ObservationDefinition.)

category

List<CodeableConcept> category

A code that classifies the general type of observation.

code

CodeableConcept code

Describes what will be observed. Sometimes this is called the observation "name".

criticalCodedValueSet

Reference criticalCodedValueSet

The set of critical coded results for the observation conforming to this ObservationDefinition.

criticalCodedValueSetTarget

ValueSet criticalCodedValueSetTarget

The actual object that is the target of the reference (The set of critical coded results for the observation conforming to this ObservationDefinition.)

identifier

List<Identifier> identifier

A unique identifier assigned to this ObservationDefinition artifact.

method

CodeableConcept method

The method or technique used to perform the observation.

multipleResultsAllowed

BooleanType multipleResultsAllowed

Multiple results allowed for observations conforming to this ObservationDefinition.

normalCodedValueSet

Reference normalCodedValueSet

The set of normal coded results for the observations conforming to this ObservationDefinition.

normalCodedValueSetTarget

ValueSet normalCodedValueSetTarget

The actual object that is the target of the reference (The set of normal coded results for the observations conforming to this ObservationDefinition.)

permittedDataType

List<Enumeration<ObservationDefinition.ObservationDataType>> permittedDataType

The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.

preferredReportName

StringType preferredReportName

The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.

qualifiedInterval

List<ObservationDefinition.ObservationDefinitionQualifiedIntervalComponent> qualifiedInterval

Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.

quantitativeDetails

ObservationDefinition.ObservationDefinitionQuantitativeDetailsComponent quantitativeDetails

Characteristics for quantitative results of this observation.

validCodedValueSet

Reference validCodedValueSet

The set of valid coded results for the observations conforming to this ObservationDefinition.

validCodedValueSetTarget

ValueSet validCodedValueSetTarget

The actual object that is the target of the reference (The set of valid coded results for the observations conforming to this ObservationDefinition.)

Class org.hl7.fhir.r4.model.ObservationDefinition.ObservationDataTypeEnumFactory

class ObservationDataTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ObservationDefinition.ObservationDefinitionQualifiedIntervalComponent

class ObservationDefinitionQualifiedIntervalComponent extends BackboneElement implements Serializable

serialVersionUID:

-416423468L

Serialized Fields

age

Range age

The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.

appliesTo

List<CodeableConcept> appliesTo

Codes to indicate the target population this reference range applies to.

category

Enumeration<ObservationDefinition.ObservationRangeCategory> category

The category of interval of values for continuous or ordinal observations conforming to this ObservationDefinition.

condition

StringType condition

Text based condition for which the reference range is valid.

context

CodeableConcept context

Codes to indicate the health context the range applies to. For example, the normal or therapeutic range.

gender

Enumeration<Enumerations.AdministrativeGender> gender

Sex of the population the range applies to.

gestationalAge

Range gestationalAge

The gestational age to which this reference range is applicable, in the context of pregnancy.

range

Range range

The low and high values determining the interval. There may be only one of the two.

Class org.hl7.fhir.r4.model.ObservationDefinition.ObservationDefinitionQuantitativeDetailsComponent

class ObservationDefinitionQuantitativeDetailsComponent extends BackboneElement implements Serializable

serialVersionUID:

1790019610L

Serialized Fields

conversionFactor

DecimalType conversionFactor

Factor for converting value expressed with SI unit to value expressed with customary unit.

customaryUnit

CodeableConcept customaryUnit

Customary unit used to report quantitative results of observations conforming to this ObservationDefinition.

decimalPrecision

IntegerType decimalPrecision

Number of digits after decimal separator when the results of such observations are of type Quantity.

unit

CodeableConcept unit

SI unit used to report quantitative results of observations conforming to this ObservationDefinition.

Class org.hl7.fhir.r4.model.ObservationDefinition.ObservationRangeCategoryEnumFactory

class ObservationRangeCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.OidType

class OidType extends UriType implements Externalizable

serialVersionUID:

3L

Serialization Methods

readExternal

public void readExternal(ObjectInput theIn)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput theOut)
                   throws IOException

Throws:

IOException

Class org.hl7.fhir.r4.model.OperationDefinition

class OperationDefinition extends MetadataResource implements Serializable

serialVersionUID:

149113671L

Serialized Fields

affectsState

BooleanType affectsState

Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.

base

CanonicalType base

Indicates that this operation definition is a constraining profile on the base.

code

CodeType code

The name used to invoke the operation.

comment

MarkdownType comment

Additional information about how to use this operation or named query.

inputProfile

CanonicalType inputProfile

Additional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole.

instance

BooleanType instance

Indicates whether this operation can be invoked on a particular instance of one of the given types.

kind

Enumeration<OperationDefinition.OperationKind> kind

Whether this is an operation or a named query.

outputProfile

CanonicalType outputProfile

Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.

overload

List<OperationDefinition.OperationDefinitionOverloadComponent> overload

Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.

parameter

List<OperationDefinition.OperationDefinitionParameterComponent> parameter

The parameters for the operation/query.

purpose

MarkdownType purpose

Explanation of why this operation definition is needed and why it has been designed as it has.

resource

List<CodeType> resource

The types on which this operation can be executed.

system

BooleanType system

Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).

type

BooleanType type

Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).

Class org.hl7.fhir.r4.model.OperationDefinition.OperationDefinitionOverloadComponent

class OperationDefinitionOverloadComponent extends BackboneElement implements Serializable

serialVersionUID:

-907948545L

Serialized Fields

comment

StringType comment

Comments to go on overload.

parameterName

List<StringType> parameterName

Name of parameter to include in overload.

Class org.hl7.fhir.r4.model.OperationDefinition.OperationDefinitionParameterBindingComponent

class OperationDefinitionParameterBindingComponent extends BackboneElement implements Serializable

serialVersionUID:

-2048653907L

Serialized Fields

strength

Enumeration<Enumerations.BindingStrength> strength

Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.

valueSet

CanonicalType valueSet

Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.

Class org.hl7.fhir.r4.model.OperationDefinition.OperationDefinitionParameterComponent

class OperationDefinitionParameterComponent extends BackboneElement implements Serializable

serialVersionUID:

1715661531L

Serialized Fields

binding

OperationDefinition.OperationDefinitionParameterBindingComponent binding

Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).

documentation

StringType documentation

Describes the meaning or use of this parameter.

max

StringType max

The maximum number of times this element is permitted to appear in the request or response.

min

IntegerType min

The minimum number of times this parameter SHALL appear in the request or response.

name

CodeType name

The name of used to identify the parameter.

part

List<OperationDefinition.OperationDefinitionParameterComponent> part

The parts of a nested Parameter.

referencedFrom

List<OperationDefinition.OperationDefinitionParameterReferencedFromComponent> referencedFrom

Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.

searchType

Enumeration<Enumerations.SearchParamType> searchType

How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.

targetProfile

List<CanonicalType> targetProfile

Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.

type

CodeType type

The type for this parameter.

use

Enumeration<OperationDefinition.OperationParameterUse> use

Whether this is an input or an output parameter.

Class org.hl7.fhir.r4.model.OperationDefinition.OperationDefinitionParameterReferencedFromComponent

class OperationDefinitionParameterReferencedFromComponent extends BackboneElement implements Serializable

serialVersionUID:

-104239783L

Serialized Fields

source

StringType source

The name of the parameter or dot-separated path of parameter names pointing to the resource parameter that is expected to contain a reference to this resource.

sourceId

StringType sourceId

The id of the element in the referencing resource that is expected to resolve to this resource.

Class org.hl7.fhir.r4.model.OperationDefinition.OperationKindEnumFactory

class OperationKindEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.OperationDefinition.OperationParameterUseEnumFactory

class OperationParameterUseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.OperationOutcome

class OperationOutcome extends DomainResource implements Serializable

serialVersionUID:

-152150052L

Serialized Fields

issue

List<OperationOutcome.OperationOutcomeIssueComponent> issue

An error, warning, or information message that results from a system action.

Class org.hl7.fhir.r4.model.OperationOutcome.IssueSeverityEnumFactory

class IssueSeverityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.OperationOutcome.IssueTypeEnumFactory

class IssueTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.OperationOutcome.OperationOutcomeIssueComponent

class OperationOutcomeIssueComponent extends BackboneElement implements Serializable

serialVersionUID:

-1681095438L

Serialized Fields

code

Enumeration<OperationOutcome.IssueType> code

Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.

details

CodeableConcept details

Additional details about the error. This may be a text description of the error or a system code that identifies the error.

diagnostics

StringType diagnostics

Additional diagnostic information about the issue.

expression

List<StringType> expression

A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.

location

List<StringType> location

This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse. For resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be "http." + the parameter name.

severity

Enumeration<OperationOutcome.IssueSeverity> severity

Indicates whether the issue indicates a variation from successful processing.

Class org.hl7.fhir.r4.model.Organization

class Organization extends DomainResource implements Serializable

serialVersionUID:

-2113244111L

Serialized Fields

active

BooleanType active

Whether the organization's record is still in active use.

address

List<Address> address

An address for the organization.

alias

List<StringType> alias

A list of alternate names that the organization is known as, or was known as in the past.

contact

List<Organization.OrganizationContactComponent> contact

Contact for the organization for a certain purpose.

endpoint

List<Reference> endpoint

Technical endpoints providing access to services operated for the organization.

endpointTarget

List<Endpoint> endpointTarget

The actual objects that are the target of the reference (Technical endpoints providing access to services operated for the organization.)

identifier

List<Identifier> identifier

Identifier for the organization that is used to identify the organization across multiple disparate systems.

name

StringType name

A name associated with the organization.

partOf

Reference partOf

The organization of which this organization forms a part.

partOfTarget

Organization partOfTarget

The actual object that is the target of the reference (The organization of which this organization forms a part.)

telecom

List<ContactPoint> telecom

A contact detail for the organization.

type

List<CodeableConcept> type

The kind(s) of organization that this is.

Class org.hl7.fhir.r4.model.Organization.OrganizationContactComponent

class OrganizationContactComponent extends BackboneElement implements Serializable

serialVersionUID:

1831121305L

Serialized Fields

address

Address address

Visiting or postal addresses for the contact.

name

HumanName name

A name associated with the contact.

purpose

CodeableConcept purpose

Indicates a purpose for which the contact can be reached.

telecom

List<ContactPoint> telecom

A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.

Class org.hl7.fhir.r4.model.OrganizationAffiliation

class OrganizationAffiliation extends DomainResource implements Serializable

serialVersionUID:

-62510821L

Serialized Fields

active

BooleanType active

Whether this organization affiliation record is in active use.

code

List<CodeableConcept> code

Definition of the role the participatingOrganization plays in the association.

endpoint

List<Reference> endpoint

Technical endpoints providing access to services operated for this role.

endpointTarget

List<Endpoint> endpointTarget

The actual objects that are the target of the reference (Technical endpoints providing access to services operated for this role.)

healthcareService

List<Reference> healthcareService

Healthcare services provided through the role.

healthcareServiceTarget

List<HealthcareService> healthcareServiceTarget

The actual objects that are the target of the reference (Healthcare services provided through the role.)

identifier

List<Identifier> identifier

Business identifiers that are specific to this role.

location

List<Reference> location

The location(s) at which the role occurs.

locationTarget

List<Location> locationTarget

The actual objects that are the target of the reference (The location(s) at which the role occurs.)

network

List<Reference> network

Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).

networkTarget

List<Organization> networkTarget

The actual objects that are the target of the reference (Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).)

organization

Reference organization

Organization where the role is available (primary organization/has members).

organizationTarget

Organization organizationTarget

The actual object that is the target of the reference (Organization where the role is available (primary organization/has members).)

participatingOrganization

Reference participatingOrganization

The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of).

participatingOrganizationTarget

Organization participatingOrganizationTarget

The actual object that is the target of the reference (The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of).)

period

Period period

The period during which the participatingOrganization is affiliated with the primary organization.

specialty

List<CodeableConcept> specialty

Specific specialty of the participatingOrganization in the context of the role.

telecom

List<ContactPoint> telecom

Contact details at the participatingOrganization relevant to this Affiliation.

Class org.hl7.fhir.r4.model.ParameterDefinition

class ParameterDefinition extends Type implements Serializable

serialVersionUID:

-1891730734L

Serialized Fields

documentation

StringType documentation

A brief discussion of what the parameter is for and how it is used by the module.

max

StringType max

The maximum number of times this element is permitted to appear in the request or response.

min

IntegerType min

The minimum number of times this parameter SHALL appear in the request or response.

name

CodeType name

The name of the parameter used to allow access to the value of the parameter in evaluation contexts.

profile

CanonicalType profile

If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.

type

CodeType type

The type of the parameter.

use

Enumeration<ParameterDefinition.ParameterUse> use

Whether the parameter is input or output for the module.

Class org.hl7.fhir.r4.model.ParameterDefinition.ParameterUseEnumFactory

class ParameterUseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Parameters

class Parameters extends Resource implements Serializable

serialVersionUID:

-1495940293L

Serialized Fields

parameter

List<Parameters.ParametersParameterComponent> parameter

A parameter passed to or received from the operation.

Class org.hl7.fhir.r4.model.Parameters.ParametersParameterComponent

class ParametersParameterComponent extends BackboneElement implements Serializable

serialVersionUID:

-1265707999L

Serialized Fields

name

StringType name

The name of the parameter (reference to the operation definition).

part

List<Parameters.ParametersParameterComponent> part

A named part of a multi-part parameter.

resource

Resource resource

If the parameter is a whole resource.

value

Type value

If the parameter is a data type.

Class org.hl7.fhir.r4.model.Patient

class Patient extends DomainResource implements Serializable

serialVersionUID:

2138656939L

Serialized Fields

active

BooleanType active

Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

address

List<Address> address

An address for the individual.

birthDate

DateType birthDate

The date of birth for the individual.

communication

List<Patient.PatientCommunicationComponent> communication

A language which may be used to communicate with the patient about his or her health.

contact

List<Patient.ContactComponent> contact

A contact party (e.g. guardian, partner, friend) for the patient.

deceased

Type deceased

Indicates if the individual is deceased or not.

gender

Enumeration<Enumerations.AdministrativeGender> gender

Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.

generalPractitioner

List<Reference> generalPractitioner

Patient's nominated care provider.

generalPractitionerTarget

List<Resource> generalPractitionerTarget

The actual objects that are the target of the reference (Patient's nominated care provider.)

identifier

List<Identifier> identifier

An identifier for this patient.

link

List<Patient.PatientLinkComponent> link

Link to another patient resource that concerns the same actual patient.

managingOrganization

Reference managingOrganization

Organization that is the custodian of the patient record.

managingOrganizationTarget

Organization managingOrganizationTarget

The actual object that is the target of the reference (Organization that is the custodian of the patient record.)

maritalStatus

CodeableConcept maritalStatus

This field contains a patient's most recent marital (civil) status.

multipleBirth

Type multipleBirth

Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

name

List<HumanName> name

A name associated with the individual.

photo

List<Attachment> photo

Image of the patient.

telecom

List<ContactPoint> telecom

A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

Class org.hl7.fhir.r4.model.Patient.ContactComponent

class ContactComponent extends BackboneElement implements Serializable

serialVersionUID:

364269017L

Serialized Fields

address

Address address

Address for the contact person.

gender

Enumeration<Enumerations.AdministrativeGender> gender

Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.

name

HumanName name

A name associated with the contact person.

organization

Reference organization

Organization on behalf of which the contact is acting or for which the contact is working.

organizationTarget

Organization organizationTarget

The actual object that is the target of the reference (Organization on behalf of which the contact is acting or for which the contact is working.)

period

Period period

The period during which this contact person or organization is valid to be contacted relating to this patient.

relationship

List<CodeableConcept> relationship

The nature of the relationship between the patient and the contact person.

telecom

List<ContactPoint> telecom

A contact detail for the person, e.g. a telephone number or an email address.

Class org.hl7.fhir.r4.model.Patient.LinkTypeEnumFactory

class LinkTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Patient.PatientCommunicationComponent

class PatientCommunicationComponent extends BackboneElement implements Serializable

serialVersionUID:

633792918L

Serialized Fields

language

CodeableConcept language

The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.

preferred

BooleanType preferred

Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

Class org.hl7.fhir.r4.model.Patient.PatientLinkComponent

class PatientLinkComponent extends BackboneElement implements Serializable

serialVersionUID:

1083576633L

Serialized Fields

other

Reference other

The other patient resource that the link refers to.

otherTarget

Resource otherTarget

The actual object that is the target of the reference (The other patient resource that the link refers to.)

type

Enumeration<Patient.LinkType> type

The type of link between this patient resource and another patient resource.

Class org.hl7.fhir.r4.model.PaymentNotice

class PaymentNotice extends DomainResource implements Serializable

serialVersionUID:

-545198613L

Serialized Fields

amount

Money amount

The amount sent to the payee.

created

DateTimeType created

The date when this resource was created.

identifier

List<Identifier> identifier

A unique identifier assigned to this payment notice.

payee

Reference payee

The party who will receive or has received payment that is the subject of this notification.

payeeTarget

Resource payeeTarget

The actual object that is the target of the reference (The party who will receive or has received payment that is the subject of this notification.)

payment

Reference payment

A reference to the payment which is the subject of this notice.

paymentDate

DateType paymentDate

The date when the above payment action occurred.

paymentStatus

CodeableConcept paymentStatus

A code indicating whether payment has been sent or cleared.

paymentTarget

PaymentReconciliation paymentTarget

The actual object that is the target of the reference (A reference to the payment which is the subject of this notice.)

provider

Reference provider

The practitioner who is responsible for the services rendered to the patient.

providerTarget

Resource providerTarget

The actual object that is the target of the reference (The practitioner who is responsible for the services rendered to the patient.)

recipient

Reference recipient

The party who is notified of the payment status.

recipientTarget

Organization recipientTarget

The actual object that is the target of the reference (The party who is notified of the payment status.)

request

Reference request

Reference of resource for which payment is being made.

requestTarget

Resource requestTarget

The actual object that is the target of the reference (Reference of resource for which payment is being made.)

response

Reference response

Reference of response to resource for which payment is being made.

responseTarget

Resource responseTarget

The actual object that is the target of the reference (Reference of response to resource for which payment is being made.)

status

Enumeration<PaymentNotice.PaymentNoticeStatus> status

The status of the resource instance.

Class org.hl7.fhir.r4.model.PaymentNotice.PaymentNoticeStatusEnumFactory

class PaymentNoticeStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.PaymentReconciliation

class PaymentReconciliation extends DomainResource implements Serializable

serialVersionUID:

-1620965037L

Serialized Fields

created

DateTimeType created

The date when the resource was created.

detail

List<PaymentReconciliation.DetailsComponent> detail

Distribution of the payment amount for a previously acknowledged payable.

disposition

StringType disposition

A human readable description of the status of the request for the reconciliation.

formCode

CodeableConcept formCode

A code for the form to be used for printing the content.

identifier

List<Identifier> identifier

A unique identifier assigned to this payment reconciliation.

outcome

Enumeration<Enumerations.RemittanceOutcome> outcome

The outcome of a request for a reconciliation.

paymentAmount

Money paymentAmount

Total payment amount as indicated on the financial instrument.

paymentDate

DateType paymentDate

The date of payment as indicated on the financial instrument.

paymentIdentifier

Identifier paymentIdentifier

Issuer's unique identifier for the payment instrument.

paymentIssuer

Reference paymentIssuer

The party who generated the payment.

paymentIssuerTarget

Organization paymentIssuerTarget

The actual object that is the target of the reference (The party who generated the payment.)

period

Period period

The period of time for which payments have been gathered into this bulk payment for settlement.

processNote

List<PaymentReconciliation.NotesComponent> processNote

A note that describes or explains the processing in a human readable form.

request

Reference request

Original request resource reference.

requestor

Reference requestor

The practitioner who is responsible for the services rendered to the patient.

requestorTarget

Resource requestorTarget

The actual object that is the target of the reference (The practitioner who is responsible for the services rendered to the patient.)

requestTarget

Task requestTarget

The actual object that is the target of the reference (Original request resource reference.)

status

Enumeration<PaymentReconciliation.PaymentReconciliationStatus> status

The status of the resource instance.

Class org.hl7.fhir.r4.model.PaymentReconciliation.DetailsComponent

class DetailsComponent extends BackboneElement implements Serializable

serialVersionUID:

-1361848619L

Serialized Fields

amount

Money amount

The monetary amount allocated from the total payment to the payable.

date

DateType date

The date from the response resource containing a commitment to pay.

identifier

Identifier identifier

Unique identifier for the current payment item for the referenced payable.

payee

Reference payee

The party which is receiving the payment.

payeeTarget

Resource payeeTarget

The actual object that is the target of the reference (The party which is receiving the payment.)

predecessor

Identifier predecessor

Unique identifier for the prior payment item for the referenced payable.

request

Reference request

A resource, such as a Claim, the evaluation of which could lead to payment.

requestTarget

Resource requestTarget

The actual object that is the target of the reference (A resource, such as a Claim, the evaluation of which could lead to payment.)

response

Reference response

A resource, such as a ClaimResponse, which contains a commitment to payment.

responseTarget

Resource responseTarget

The actual object that is the target of the reference (A resource, such as a ClaimResponse, which contains a commitment to payment.)

responsible

Reference responsible

A reference to the individual who is responsible for inquiries regarding the response and its payment.

responsibleTarget

PractitionerRole responsibleTarget

The actual object that is the target of the reference (A reference to the individual who is responsible for inquiries regarding the response and its payment.)

submitter

Reference submitter

The party which submitted the claim or financial transaction.

submitterTarget

Resource submitterTarget

The actual object that is the target of the reference (The party which submitted the claim or financial transaction.)

type

CodeableConcept type

Code to indicate the nature of the payment.

Class org.hl7.fhir.r4.model.PaymentReconciliation.NotesComponent

class NotesComponent extends BackboneElement implements Serializable

serialVersionUID:

529250161L

Serialized Fields

text

StringType text

The explanation or description associated with the processing.

type

Enumeration<Enumerations.NoteType> type

The business purpose of the note text.

Class org.hl7.fhir.r4.model.PaymentReconciliation.PaymentReconciliationStatusEnumFactory

class PaymentReconciliationStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Period

class Period extends Type implements Serializable

serialVersionUID:

649791751L

Serialized Fields

end

DateTimeType end

The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

start

DateTimeType start

The start of the period. The boundary is inclusive.

Class org.hl7.fhir.r4.model.Person

class Person extends DomainResource implements Serializable

serialVersionUID:

-117464654L

Serialized Fields

active

BooleanType active

Whether this person's record is in active use.

address

List<Address> address

One or more addresses for the person.

birthDate

DateType birthDate

The birth date for the person.

gender

Enumeration<Enumerations.AdministrativeGender> gender

Administrative Gender.

identifier

List<Identifier> identifier

Identifier for a person within a particular scope.

link

List<Person.PersonLinkComponent> link

Link to a resource that concerns the same actual person.

managingOrganization

Reference managingOrganization

The organization that is the custodian of the person record.

managingOrganizationTarget

Organization managingOrganizationTarget

The actual object that is the target of the reference (The organization that is the custodian of the person record.)

name

List<HumanName> name

A name associated with the person.

photo

Attachment photo

An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.

telecom

List<ContactPoint> telecom

A contact detail for the person, e.g. a telephone number or an email address.

Class org.hl7.fhir.r4.model.Person.IdentityAssuranceLevelEnumFactory

class IdentityAssuranceLevelEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Person.PersonLinkComponent

class PersonLinkComponent extends BackboneElement implements Serializable

serialVersionUID:

508763647L

Serialized Fields

assurance

Enumeration<Person.IdentityAssuranceLevel> assurance

Level of assurance that this link is associated with the target resource.

target

Reference target

The resource to which this actual person is associated.

targetTarget

Resource targetTarget

The actual object that is the target of the reference (The resource to which this actual person is associated.)

Class org.hl7.fhir.r4.model.PlanDefinition

class PlanDefinition extends MetadataResource implements Serializable

serialVersionUID:

-1725695645L

Serialized Fields

action

List<PlanDefinition.PlanDefinitionActionComponent> action

An action or group of actions to be taken as part of the plan.

approvalDate

DateType approvalDate

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

author

List<ContactDetail> author

An individiual or organization primarily involved in the creation and maintenance of the content.

copyright

MarkdownType copyright

A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.

editor

List<ContactDetail> editor

An individual or organization primarily responsible for internal coherence of the content.

effectivePeriod

Period effectivePeriod

The period during which the plan definition content was or is planned to be in active use.

endorser

List<ContactDetail> endorser

An individual or organization responsible for officially endorsing the content for use in some setting.

goal

List<PlanDefinition.PlanDefinitionGoalComponent> goal

Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.

identifier

List<Identifier> identifier

A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

lastReviewDate

DateType lastReviewDate

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

library

List<CanonicalType> library

A reference to a Library resource containing any formal logic used by the plan definition.

purpose

MarkdownType purpose

Explanation of why this plan definition is needed and why it has been designed as it has.

relatedArtifact

List<RelatedArtifact> relatedArtifact

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

reviewer

List<ContactDetail> reviewer

An individual or organization primarily responsible for review of some aspect of the content.

subject

Type subject

A code or group definition that describes the intended subject of the plan definition.

subtitle

StringType subtitle

An explanatory or alternate title for the plan definition giving additional information about its content.

topic

List<CodeableConcept> topic

Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.

type

CodeableConcept type

A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.

usage

StringType usage

A detailed description of how the plan definition is used from a clinical perspective.

Class org.hl7.fhir.r4.model.PlanDefinition.ActionCardinalityBehaviorEnumFactory

class ActionCardinalityBehaviorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.PlanDefinition.ActionConditionKindEnumFactory

class ActionConditionKindEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.PlanDefinition.ActionGroupingBehaviorEnumFactory

class ActionGroupingBehaviorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.PlanDefinition.ActionParticipantTypeEnumFactory

class ActionParticipantTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.PlanDefinition.ActionPrecheckBehaviorEnumFactory

class ActionPrecheckBehaviorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.PlanDefinition.ActionRelationshipTypeEnumFactory

class ActionRelationshipTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.PlanDefinition.ActionRequiredBehaviorEnumFactory

class ActionRequiredBehaviorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.PlanDefinition.ActionSelectionBehaviorEnumFactory

class ActionSelectionBehaviorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.PlanDefinition.PlanDefinitionActionComponent

class PlanDefinitionActionComponent extends BackboneElement implements Serializable

serialVersionUID:

158605540L

Serialized Fields

action

List<PlanDefinition.PlanDefinitionActionComponent> action

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

cardinalityBehavior

Enumeration<PlanDefinition.ActionCardinalityBehavior> cardinalityBehavior

Defines whether the action can be selected multiple times.

code

List<CodeableConcept> code

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

condition

List<PlanDefinition.PlanDefinitionActionConditionComponent> condition

An expression that describes applicability criteria or start/stop conditions for the action.

definition

Type definition

A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.

description

StringType description

A brief description of the action used to provide a summary to display to the user.

documentation

List<RelatedArtifact> documentation

Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.

dynamicValue

List<PlanDefinition.PlanDefinitionActionDynamicValueComponent> dynamicValue

Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.

goalId

List<IdType> goalId

Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.

groupingBehavior

Enumeration<PlanDefinition.ActionGroupingBehavior> groupingBehavior

Defines the grouping behavior for the action and its children.

input

List<DataRequirement> input

Defines input data requirements for the action.

output

List<DataRequirement> output

Defines the outputs of the action, if any.

participant

List<PlanDefinition.PlanDefinitionActionParticipantComponent> participant

Indicates who should participate in performing the action described.

precheckBehavior

Enumeration<PlanDefinition.ActionPrecheckBehavior> precheckBehavior

Defines whether the action should usually be preselected.

prefix

StringType prefix

A user-visible prefix for the action.

priority

Enumeration<PlanDefinition.RequestPriority> priority

Indicates how quickly the action should be addressed with respect to other actions.

reason

List<CodeableConcept> reason

A description of why this action is necessary or appropriate.

relatedAction

List<PlanDefinition.PlanDefinitionActionRelatedActionComponent> relatedAction

A relationship to another action such as "before" or "30-60 minutes after start of".

requiredBehavior

Enumeration<PlanDefinition.ActionRequiredBehavior> requiredBehavior

Defines the required behavior for the action.

selectionBehavior

Enumeration<PlanDefinition.ActionSelectionBehavior> selectionBehavior

Defines the selection behavior for the action and its children.

subject

Type subject

A code or group definition that describes the intended subject of the action and its children, if any.

textEquivalent

StringType textEquivalent

A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.

timing

Type timing

An optional value describing when the action should be performed.

title

StringType title

The title of the action displayed to a user.

transform

CanonicalType transform

A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

trigger

List<TriggerDefinition> trigger

A description of when the action should be triggered.

type

CodeableConcept type

The type of action to perform (create, update, remove).

Class org.hl7.fhir.r4.model.PlanDefinition.PlanDefinitionActionConditionComponent

class PlanDefinitionActionConditionComponent extends BackboneElement implements Serializable

serialVersionUID:

-455150438L

Serialized Fields

expression

Expression expression

An expression that returns true or false, indicating whether the condition is satisfied.

kind

Enumeration<PlanDefinition.ActionConditionKind> kind

The kind of condition.

Class org.hl7.fhir.r4.model.PlanDefinition.PlanDefinitionActionDynamicValueComponent

class PlanDefinitionActionDynamicValueComponent extends BackboneElement implements Serializable

serialVersionUID:

1064529082L

Serialized Fields

expression

Expression expression

An expression specifying the value of the customized element.

path

StringType path

The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).

Class org.hl7.fhir.r4.model.PlanDefinition.PlanDefinitionActionParticipantComponent

class PlanDefinitionActionParticipantComponent extends BackboneElement implements Serializable

serialVersionUID:

-1152013659L

Serialized Fields

role

CodeableConcept role

The role the participant should play in performing the described action.

type

Enumeration<PlanDefinition.ActionParticipantType> type

The type of participant in the action.

Class org.hl7.fhir.r4.model.PlanDefinition.PlanDefinitionActionRelatedActionComponent

class PlanDefinitionActionRelatedActionComponent extends BackboneElement implements Serializable

serialVersionUID:

1063306770L

Serialized Fields

actionId

IdType actionId

The element id of the related action.

offset

Type offset

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

relationship

Enumeration<PlanDefinition.ActionRelationshipType> relationship

The relationship of this action to the related action.

Class org.hl7.fhir.r4.model.PlanDefinition.PlanDefinitionGoalComponent

class PlanDefinitionGoalComponent extends BackboneElement implements Serializable

serialVersionUID:

-795308926L

Serialized Fields

addresses

List<CodeableConcept> addresses

Identifies problems, conditions, issues, or concerns the goal is intended to address.

category

CodeableConcept category

Indicates a category the goal falls within.

description

CodeableConcept description

Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".

documentation

List<RelatedArtifact> documentation

Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.

priority

CodeableConcept priority

Identifies the expected level of importance associated with reaching/sustaining the defined goal.

start

CodeableConcept start

The event after which the goal should begin being pursued.

target

List<PlanDefinition.PlanDefinitionGoalTargetComponent> target

Indicates what should be done and within what timeframe.

Class org.hl7.fhir.r4.model.PlanDefinition.PlanDefinitionGoalTargetComponent

class PlanDefinitionGoalTargetComponent extends BackboneElement implements Serializable

serialVersionUID:

-131874144L

Serialized Fields

detail

Type detail

The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.

due

Duration due

Indicates the timeframe after the start of the goal in which the goal should be met.

measure

CodeableConcept measure

The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.

Class org.hl7.fhir.r4.model.PlanDefinition.RequestPriorityEnumFactory

class RequestPriorityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Population

class Population extends BackboneType implements Serializable

serialVersionUID:

495777760L

Serialized Fields

age

Type age

The age of the specific population.

gender

CodeableConcept gender

The gender of the specific population.

physiologicalCondition

CodeableConcept physiologicalCondition

The existing physiological conditions of the specific population to which this applies.

race

CodeableConcept race

Race of the specific population.

Class org.hl7.fhir.r4.model.PositiveIntType

class PositiveIntType extends IntegerType implements Externalizable

serialVersionUID:

1686497884249402429L

Serialization Methods

readExternal

public void readExternal(ObjectInput theIn)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput theOut)
                   throws IOException

Throws:

IOException

Class org.hl7.fhir.r4.model.Practitioner

class Practitioner extends DomainResource implements Serializable

serialVersionUID:

2128349259L

Serialized Fields

active

BooleanType active

Whether this practitioner's record is in active use.

address

List<Address> address

Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.

birthDate

DateType birthDate

The date of birth for the practitioner.

communication

List<CodeableConcept> communication

A language the practitioner can use in patient communication.

gender

Enumeration<Enumerations.AdministrativeGender> gender

Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

identifier

List<Identifier> identifier

An identifier that applies to this person in this role.

name

List<HumanName> name

The name(s) associated with the practitioner.

photo

List<Attachment> photo

Image of the person.

qualification

List<Practitioner.PractitionerQualificationComponent> qualification

The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.

telecom

List<ContactPoint> telecom

A contact detail for the practitioner, e.g. a telephone number or an email address.

Class org.hl7.fhir.r4.model.Practitioner.PractitionerQualificationComponent

class PractitionerQualificationComponent extends BackboneElement implements Serializable

serialVersionUID:

1095219071L

Serialized Fields

code

CodeableConcept code

Coded representation of the qualification.

identifier

List<Identifier> identifier

An identifier that applies to this person's qualification in this role.

issuer

Reference issuer

Organization that regulates and issues the qualification.

issuerTarget

Organization issuerTarget

The actual object that is the target of the reference (Organization that regulates and issues the qualification.)

period

Period period

Period during which the qualification is valid.

Class org.hl7.fhir.r4.model.PractitionerRole

class PractitionerRole extends DomainResource implements Serializable

serialVersionUID:

423338051L

Serialized Fields

active

BooleanType active

Whether this practitioner role record is in active use.

availabilityExceptions

StringType availabilityExceptions

A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.

availableTime

List<PractitionerRole.PractitionerRoleAvailableTimeComponent> availableTime

A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.

code

List<CodeableConcept> code

Roles which this practitioner is authorized to perform for the organization.

endpoint

List<Reference> endpoint

Technical endpoints providing access to services operated for the practitioner with this role.

endpointTarget

List<Endpoint> endpointTarget

The actual objects that are the target of the reference (Technical endpoints providing access to services operated for the practitioner with this role.)

healthcareService

List<Reference> healthcareService

The list of healthcare services that this worker provides for this role's Organization/Location(s).

healthcareServiceTarget

List<HealthcareService> healthcareServiceTarget

The actual objects that are the target of the reference (The list of healthcare services that this worker provides for this role's Organization/Location(s).)

identifier

List<Identifier> identifier

Business Identifiers that are specific to a role/location.

location

List<Reference> location

The location(s) at which this practitioner provides care.

locationTarget

List<Location> locationTarget

The actual objects that are the target of the reference (The location(s) at which this practitioner provides care.)

notAvailable

List<PractitionerRole.PractitionerRoleNotAvailableComponent> notAvailable

The practitioner is not available or performing this role during this period of time due to the provided reason.

organization

Reference organization

The organization where the Practitioner performs the roles associated.

organizationTarget

Organization organizationTarget

The actual object that is the target of the reference (The organization where the Practitioner performs the roles associated.)

period

Period period

The period during which the person is authorized to act as a practitioner in these role(s) for the organization.

practitioner

Reference practitioner

Practitioner that is able to provide the defined services for the organization.

practitionerTarget

Practitioner practitionerTarget

The actual object that is the target of the reference (Practitioner that is able to provide the defined services for the organization.)

specialty

List<CodeableConcept> specialty

Specific specialty of the practitioner.

telecom

List<ContactPoint> telecom

Contact details that are specific to the role/location/service.

Class org.hl7.fhir.r4.model.PractitionerRole.DaysOfWeekEnumFactory

class DaysOfWeekEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.PractitionerRole.PractitionerRoleAvailableTimeComponent

class PractitionerRoleAvailableTimeComponent extends BackboneElement implements Serializable

serialVersionUID:

-2139510127L

Serialized Fields

allDay

BooleanType allDay

Is this always available? (hence times are irrelevant) e.g. 24 hour service.

availableEndTime

TimeType availableEndTime

The closing time of day. Note: If the AllDay flag is set, then this time is ignored.

availableStartTime

TimeType availableStartTime

The opening time of day. Note: If the AllDay flag is set, then this time is ignored.

daysOfWeek

List<Enumeration<PractitionerRole.DaysOfWeek>> daysOfWeek

Indicates which days of the week are available between the start and end Times.

Class org.hl7.fhir.r4.model.PractitionerRole.PractitionerRoleNotAvailableComponent

class PractitionerRoleNotAvailableComponent extends BackboneElement implements Serializable

serialVersionUID:

310849929L

Serialized Fields

description

StringType description

The reason that can be presented to the user as to why this time is not available.

during

Period during

Service is not available (seasonally or for a public holiday) from this date.

Class org.hl7.fhir.r4.model.PrimitiveType

class PrimitiveType extends Type implements Externalizable

serialVersionUID:

3L

Serialization Methods

readExternal

public void readExternal(ObjectInput theIn)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput theOut)
                   throws IOException

Throws:

IOException

Class org.hl7.fhir.r4.model.Procedure

class Procedure extends DomainResource implements Serializable

serialVersionUID:

-29072720L

Serialized Fields

asserter

Reference asserter

Individual who is making the procedure statement.

asserterTarget

Resource asserterTarget

The actual object that is the target of the reference (Individual who is making the procedure statement.)

basedOn

List<Reference> basedOn

A reference to a resource that contains details of the request for this procedure.

basedOnTarget

List<Resource> basedOnTarget

The actual objects that are the target of the reference (A reference to a resource that contains details of the request for this procedure.)

bodySite

List<CodeableConcept> bodySite

Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.

category

CodeableConcept category

A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").

code

CodeableConcept code

The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy").

complication

List<CodeableConcept> complication

Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.

complicationDetail

List<Reference> complicationDetail

Any complications that occurred during the procedure, or in the immediate post-performance period.

complicationDetailTarget

List<Condition> complicationDetailTarget

The actual objects that are the target of the reference (Any complications that occurred during the procedure, or in the immediate post-performance period.)

encounter

Reference encounter

The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.)

focalDevice

List<Procedure.ProcedureFocalDeviceComponent> focalDevice

A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.

followUp

List<CodeableConcept> followUp

If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.

identifier

List<Identifier> identifier

Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.

instantiatesCanonical

List<CanonicalType> instantiatesCanonical

The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.

instantiatesUri

List<UriType> instantiatesUri

The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.

location

Reference location

The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.

locationTarget

Location locationTarget

The actual object that is the target of the reference (The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.)

note

List<Annotation> note

Any other notes and comments about the procedure.

outcome

CodeableConcept outcome

The outcome of the procedure - did it resolve the reasons for the procedure being performed?

partOf

List<Reference> partOf

A larger event of which this particular procedure is a component or step.

partOfTarget

List<Resource> partOfTarget

The actual objects that are the target of the reference (A larger event of which this particular procedure is a component or step.)

performed

Type performed

Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

performer

List<Procedure.ProcedurePerformerComponent> performer

Limited to "real" people rather than equipment.

reasonCode

List<CodeableConcept> reasonCode

The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text.

reasonReference

List<Reference> reasonReference

The justification of why the procedure was performed.

reasonReferenceTarget

List<Resource> reasonReferenceTarget

The actual objects that are the target of the reference (The justification of why the procedure was performed.)

recorder

Reference recorder

Individual who recorded the record and takes responsibility for its content.

recorderTarget

Resource recorderTarget

The actual object that is the target of the reference (Individual who recorded the record and takes responsibility for its content.)

report

List<Reference> report

This could be a histology result, pathology report, surgical report, etc.

reportTarget

List<Resource> reportTarget

The actual objects that are the target of the reference (This could be a histology result, pathology report, surgical report, etc.)

status

Enumeration<Procedure.ProcedureStatus> status

A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.

statusReason

CodeableConcept statusReason

Captures the reason for the current state of the procedure.

subject

Reference subject

The person, animal or group on which the procedure was performed.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (The person, animal or group on which the procedure was performed.)

usedCode

List<CodeableConcept> usedCode

Identifies coded items that were used as part of the procedure.

usedReference

List<Reference> usedReference

Identifies medications, devices and any other substance used as part of the procedure.

usedReferenceTarget

List<Resource> usedReferenceTarget

The actual objects that are the target of the reference (Identifies medications, devices and any other substance used as part of the procedure.)

Class org.hl7.fhir.r4.model.Procedure.ProcedureFocalDeviceComponent

class ProcedureFocalDeviceComponent extends BackboneElement implements Serializable

serialVersionUID:

1779937807L

Serialized Fields

action

CodeableConcept action

The kind of change that happened to the device during the procedure.

manipulated

Reference manipulated

The device that was manipulated (changed) during the procedure.

manipulatedTarget

Device manipulatedTarget

The actual object that is the target of the reference (The device that was manipulated (changed) during the procedure.)

Class org.hl7.fhir.r4.model.Procedure.ProcedurePerformerComponent

class ProcedurePerformerComponent extends BackboneElement implements Serializable

serialVersionUID:

-997772724L

Serialized Fields

actor

Reference actor

The practitioner who was involved in the procedure.

actorTarget

Resource actorTarget

The actual object that is the target of the reference (The practitioner who was involved in the procedure.)

function

CodeableConcept function

Distinguishes the type of involvement of the performer in the procedure. For example, surgeon, anaesthetist, endoscopist.

onBehalfOf

Reference onBehalfOf

The organization the device or practitioner was acting on behalf of.

onBehalfOfTarget

Organization onBehalfOfTarget

The actual object that is the target of the reference (The organization the device or practitioner was acting on behalf of.)

Class org.hl7.fhir.r4.model.Procedure.ProcedureStatusEnumFactory

class ProcedureStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ProdCharacteristic

class ProdCharacteristic extends BackboneType implements Serializable

serialVersionUID:

1521671432L

Serialized Fields

color

List<StringType> color

Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.

depth

Quantity depth

Where applicable, the depth can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.

externalDiameter

Quantity externalDiameter

Where applicable, the external diameter can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.

height

Quantity height

Where applicable, the height can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.

image

List<Attachment> image

Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations.

imprint

List<StringType> imprint

Where applicable, the imprint can be specified as text.

nominalVolume

Quantity nominalVolume

Where applicable, the nominal volume can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.

scoring

CodeableConcept scoring

Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.

shape

StringType shape

Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.

weight

Quantity weight

Where applicable, the weight can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.

width

Quantity width

Where applicable, the width can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.

Class org.hl7.fhir.r4.model.ProductShelfLife

class ProductShelfLife extends BackboneType implements Serializable

serialVersionUID:

-1561196410L

Serialized Fields

identifier

Identifier identifier

Unique identifier for the packaged Medicinal Product.

period

Quantity period

The shelf life time period can be specified using a numerical value for the period of time and its unit of time measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.

specialPrecautionsForStorage

List<CodeableConcept> specialPrecautionsForStorage

Special precautions for storage, if any, can be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified.

type

CodeableConcept type

This describes the shelf life, taking into account various scenarios such as shelf life of the packaged Medicinal Product itself, shelf life after transformation where necessary and shelf life after the first opening of a bottle, etc. The shelf life type shall be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified.

Class org.hl7.fhir.r4.model.Provenance

class Provenance extends DomainResource implements Serializable

serialVersionUID:

-1991881518L

Serialized Fields

activity

CodeableConcept activity

An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.

agent

List<Provenance.ProvenanceAgentComponent> agent

An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.

entity

List<Provenance.ProvenanceEntityComponent> entity

An entity used in this activity.

location

Reference location

Where the activity occurred, if relevant.

locationTarget

Location locationTarget

The actual object that is the target of the reference (Where the activity occurred, if relevant.)

occurred

Type occurred

The period during which the activity occurred.

policy

List<UriType> policy

Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.

reason

List<CodeableConcept> reason

The reason that the activity was taking place.

recorded

InstantType recorded

The instant of time at which the activity was recorded.

signature

List<Signature> signature

A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.

target

List<Reference> target

The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.

targetTarget

List<Resource> targetTarget

The actual objects that are the target of the reference (The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.)

Class org.hl7.fhir.r4.model.Provenance.ProvenanceAgentComponent

class ProvenanceAgentComponent extends BackboneElement implements Serializable

serialVersionUID:

-1363252586L

Serialized Fields

onBehalfOf

Reference onBehalfOf

The individual, device, or organization for whom the change was made.

onBehalfOfTarget

Resource onBehalfOfTarget

The actual object that is the target of the reference (The individual, device, or organization for whom the change was made.)

role

List<CodeableConcept> role

The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.

type

CodeableConcept type

The participation the agent had with respect to the activity.

who

Reference who

The individual, device or organization that participated in the event.

whoTarget

Resource whoTarget

The actual object that is the target of the reference (The individual, device or organization that participated in the event.)

Class org.hl7.fhir.r4.model.Provenance.ProvenanceEntityComponent

class ProvenanceEntityComponent extends BackboneElement implements Serializable

serialVersionUID:

144967401L

Serialized Fields

agent

List<Provenance.ProvenanceAgentComponent> agent

The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity.

role

Enumeration<Provenance.ProvenanceEntityRole> role

How the entity was used during the activity.

what

Reference what

Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.

whatTarget

Resource whatTarget

The actual object that is the target of the reference (Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.)

Class org.hl7.fhir.r4.model.Provenance.ProvenanceEntityRoleEnumFactory

class ProvenanceEntityRoleEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Quantity

class Quantity extends Type implements Serializable

serialVersionUID:

1069574054L

Serialized Fields

code

CodeType code

A computer processable form of the unit in some unit representation system.

comparator

Enumeration<Quantity.QuantityComparator> comparator

How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "invalid input: '<'" , then the real value is invalid input: '<' stated value.

system

UriType system

The identification of the system that provides the coded form of the unit.

unit

StringType unit

A human-readable form of the unit.

value

DecimalType value

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Class org.hl7.fhir.r4.model.Quantity.QuantityComparatorEnumFactory

class QuantityComparatorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Questionnaire

class Questionnaire extends MetadataResource implements Serializable

serialVersionUID:

1036031192L

Serialized Fields

approvalDate

DateType approvalDate

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

code

List<Coding> code

An identifier for this question or group of questions in a particular terminology such as LOINC.

copyright

MarkdownType copyright

A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire.

derivedFrom

List<CanonicalType> derivedFrom

The URL of a Questionnaire that this Questionnaire is based on.

effectivePeriod

Period effectivePeriod

The period during which the questionnaire content was or is planned to be in active use.

identifier

List<Identifier> identifier

A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.

item

List<Questionnaire.QuestionnaireItemComponent> item

A particular question, question grouping or display text that is part of the questionnaire.

lastReviewDate

DateType lastReviewDate

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

purpose

MarkdownType purpose

Explanation of why this questionnaire is needed and why it has been designed as it has.

subjectType

List<CodeType> subjectType

The types of subjects that can be the subject of responses created for the questionnaire.

Class org.hl7.fhir.r4.model.Questionnaire.EnableWhenBehaviorEnumFactory

class EnableWhenBehaviorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Questionnaire.QuestionnaireItemAnswerOptionComponent

class QuestionnaireItemAnswerOptionComponent extends BackboneElement implements Serializable

serialVersionUID:

1703686148L

Serialized Fields

initialSelected

BooleanType initialSelected

Indicates whether the answer value is selected when the list of possible answers is initially shown.

value

Type value

A potential answer that's allowed as the answer to this question.

Class org.hl7.fhir.r4.model.Questionnaire.QuestionnaireItemComponent

class QuestionnaireItemComponent extends BackboneElement implements Serializable

serialVersionUID:

-1503380450L

Serialized Fields

answerOption

List<Questionnaire.QuestionnaireItemAnswerOptionComponent> answerOption

One of the permitted answers for a "choice" or "open-choice" question.

answerValueSet

CanonicalType answerValueSet

A reference to a value set containing a list of codes representing permitted answers for a "choice" or "open-choice" question.

code

List<Coding> code

A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).

definition

UriType definition

This element is a URI that refers to an [[[ElementDefinition]]] that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource. A detailed description of the construction of the URI is shown in Comments, below. If this element is present then the following element values MAY be derived from the Element Definition if the corresponding elements of this Questionnaire resource instance have no value: code (ElementDefinition.code) type (ElementDefinition.type) required (ElementDefinition.min) repeats (ElementDefinition.max) maxLength (ElementDefinition.maxLength) answerValueSet (ElementDefinition.binding) options (ElementDefinition.binding).

enableBehavior

Enumeration<Questionnaire.EnableWhenBehavior> enableBehavior

Controls how multiple enableWhen values are interpreted - whether all or any must be true.

enableWhen

List<Questionnaire.QuestionnaireItemEnableWhenComponent> enableWhen

A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.

initial

List<Questionnaire.QuestionnaireItemInitialComponent> initial

One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input.

item

List<Questionnaire.QuestionnaireItemComponent> item

Text, questions and other groups to be nested beneath a question or group.

linkId

StringType linkId

An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.

maxLength

IntegerType maxLength

The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse.

prefix

StringType prefix

A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.

readOnly

BooleanType readOnly

An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.

repeats

BooleanType repeats

An indication, if true, that the item may occur multiple times in the response, collecting multiple answers for questions or multiple sets of answers for groups.

required

BooleanType required

An indication, if true, that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.

text

StringType text

The name of a section, the text of a question or text content for a display item.

type

Enumeration<Questionnaire.QuestionnaireItemType> type

The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, coded choice, etc.).

Class org.hl7.fhir.r4.model.Questionnaire.QuestionnaireItemEnableWhenComponent

class QuestionnaireItemEnableWhenComponent extends BackboneElement implements Serializable

serialVersionUID:

-1815133868L

Serialized Fields

answer

Type answer

A value that the referenced question is tested using the specified operator in order for the item to be enabled.

operator

Enumeration<Questionnaire.QuestionnaireItemOperator> operator

Specifies the criteria by which the question is enabled.

question

StringType question

The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.

Class org.hl7.fhir.r4.model.Questionnaire.QuestionnaireItemInitialComponent

class QuestionnaireItemInitialComponent extends BackboneElement implements Serializable

serialVersionUID:

-732981989L

Serialized Fields

value

Type value

The actual value to for an initial answer.

Class org.hl7.fhir.r4.model.Questionnaire.QuestionnaireItemOperatorEnumFactory

class QuestionnaireItemOperatorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Questionnaire.QuestionnaireItemTypeEnumFactory

class QuestionnaireItemTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.QuestionnaireResponse

class QuestionnaireResponse extends DomainResource implements Serializable

serialVersionUID:

-259908687L

Serialized Fields

author

Reference author

Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.

authored

DateTimeType authored

The date and/or time that this set of answers were last changed.

authorTarget

Resource authorTarget

The actual object that is the target of the reference (Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.)

basedOn

List<Reference> basedOn

The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.

basedOnTarget

List<Resource> basedOnTarget

The actual objects that are the target of the reference (The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.)

encounter

Reference encounter

The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.)

identifier

Identifier identifier

A business identifier assigned to a particular completed (or partially completed) questionnaire.

item

List<QuestionnaireResponse.QuestionnaireResponseItemComponent> item

A group or question item from the original questionnaire for which answers are provided.

partOf

List<Reference> partOf

A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of.

partOfTarget

List<Resource> partOfTarget

The actual objects that are the target of the reference (A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of.)

questionnaire

CanonicalType questionnaire

The Questionnaire that defines and organizes the questions for which answers are being provided.

source

Reference source

The person who answered the questions about the subject.

sourceTarget

Resource sourceTarget

The actual object that is the target of the reference (The person who answered the questions about the subject.)

status

Enumeration<QuestionnaireResponse.QuestionnaireResponseStatus> status

The position of the questionnaire response within its overall lifecycle.

subject

Reference subject

The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information.)

Class org.hl7.fhir.r4.model.QuestionnaireResponse.QuestionnaireResponseItemAnswerComponent

class QuestionnaireResponseItemAnswerComponent extends BackboneElement implements Serializable

serialVersionUID:

2052422636L

Serialized Fields

item

List<QuestionnaireResponse.QuestionnaireResponseItemComponent> item

Nested groups and/or questions found within this particular answer.

value

Type value

The answer (or one of the answers) provided by the respondent to the question.

Class org.hl7.fhir.r4.model.QuestionnaireResponse.QuestionnaireResponseItemComponent

class QuestionnaireResponseItemComponent extends BackboneElement implements Serializable

serialVersionUID:

-1395483402L

Serialized Fields

answer

List<QuestionnaireResponse.QuestionnaireResponseItemAnswerComponent> answer

The respondent's answer(s) to the question.

definition

UriType definition

A reference to an [[[ElementDefinition]]] that provides the details for the item.

item

List<QuestionnaireResponse.QuestionnaireResponseItemComponent> item

Questions or sub-groups nested beneath a question or group.

linkId

StringType linkId

The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource.

text

StringType text

Text that is displayed above the contents of the group or as the text of the question being answered.

Class org.hl7.fhir.r4.model.QuestionnaireResponse.QuestionnaireResponseStatusEnumFactory

class QuestionnaireResponseStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Range

class Range extends Type implements Serializable

serialVersionUID:

-474933350L

Serialized Fields

high

Quantity high

The high limit. The boundary is inclusive.

low

Quantity low

The low limit. The boundary is inclusive.

Class org.hl7.fhir.r4.model.Ratio

class Ratio extends Type implements Serializable

serialVersionUID:

479922563L

Serialized Fields

denominator

Quantity denominator

The value of the denominator.

numerator

Quantity numerator

The value of the numerator.

Class org.hl7.fhir.r4.model.Reference

class Reference extends BaseReference implements Serializable

serialVersionUID:

784245805L

Serialized Fields

display

StringType display

Plain text narrative that identifies the resource in addition to the resource reference.

identifier

Identifier identifier

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

reference

StringType reference

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

type

UriType type

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

Class org.hl7.fhir.r4.model.RelatedArtifact

class RelatedArtifact extends Type implements Serializable

serialVersionUID:

-695743528L

Serialized Fields

citation

MarkdownType citation

A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

display

StringType display

A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

document

Attachment document

The document being referenced, represented as an attachment. This is exclusive with the resource element.

label

StringType label

A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.

resource

CanonicalType resource

The related resource, such as a library, value set, profile, or other knowledge resource.

type

Enumeration<RelatedArtifact.RelatedArtifactType> type

The type of relationship to the related artifact.

url

UrlType url

A url for the artifact that can be followed to access the actual content.

Class org.hl7.fhir.r4.model.RelatedArtifact.RelatedArtifactTypeEnumFactory

class RelatedArtifactTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.RelatedPerson

class RelatedPerson extends DomainResource implements Serializable

serialVersionUID:

-1396330390L

Serialized Fields

active

BooleanType active

Whether this related person record is in active use.

address

List<Address> address

Address where the related person can be contacted or visited.

birthDate

DateType birthDate

The date on which the related person was born.

communication

List<RelatedPerson.RelatedPersonCommunicationComponent> communication

A language which may be used to communicate with about the patient's health.

gender

Enumeration<Enumerations.AdministrativeGender> gender

Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

identifier

List<Identifier> identifier

Identifier for a person within a particular scope.

name

List<HumanName> name

A name associated with the person.

patient

Reference patient

The patient this person is related to.

patientTarget

Patient patientTarget

The actual object that is the target of the reference (The patient this person is related to.)

period

Period period

The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.

photo

List<Attachment> photo

Image of the person.

relationship

List<CodeableConcept> relationship

The nature of the relationship between a patient and the related person.

telecom

List<ContactPoint> telecom

A contact detail for the person, e.g. a telephone number or an email address.

Class org.hl7.fhir.r4.model.RelatedPerson.RelatedPersonCommunicationComponent

class RelatedPersonCommunicationComponent extends BackboneElement implements Serializable

serialVersionUID:

633792918L

Serialized Fields

language

CodeableConcept language

The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.

preferred

BooleanType preferred

Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

Class org.hl7.fhir.r4.model.RequestGroup

class RequestGroup extends DomainResource implements Serializable

serialVersionUID:

-2053492070L

Serialized Fields

action

List<RequestGroup.RequestGroupActionComponent> action

The actions, if any, produced by the evaluation of the artifact.

author

Reference author

Provides a reference to the author of the request group.

authoredOn

DateTimeType authoredOn

Indicates when the request group was created.

authorTarget

Resource authorTarget

The actual object that is the target of the reference (Provides a reference to the author of the request group.)

basedOn

List<Reference> basedOn

A plan, proposal or order that is fulfilled in whole or in part by this request.

basedOnTarget

List<Resource> basedOnTarget

The actual objects that are the target of the reference (A plan, proposal or order that is fulfilled in whole or in part by this request.)

code

CodeableConcept code

A code that identifies what the overall request group is.

encounter

Reference encounter

Describes the context of the request group, if any.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (Describes the context of the request group, if any.)

groupIdentifier

Identifier groupIdentifier

A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.

identifier

List<Identifier> identifier

Allows a service to provide a unique, business identifier for the request.

instantiatesCanonical

List<CanonicalType> instantiatesCanonical

A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.

instantiatesUri

List<UriType> instantiatesUri

A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.

intent

Enumeration<RequestGroup.RequestIntent> intent

Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.

note

List<Annotation> note

Provides a mechanism to communicate additional information about the response.

priority

Enumeration<RequestGroup.RequestPriority> priority

Indicates how quickly the request should be addressed with respect to other requests.

reasonCode

List<CodeableConcept> reasonCode

Describes the reason for the request group in coded or textual form.

reasonReference

List<Reference> reasonReference

Indicates another resource whose existence justifies this request group.

reasonReferenceTarget

List<Resource> reasonReferenceTarget

The actual objects that are the target of the reference (Indicates another resource whose existence justifies this request group.)

replaces

List<Reference> replaces

Completed or terminated request(s) whose function is taken by this new request.

replacesTarget

List<Resource> replacesTarget

The actual objects that are the target of the reference (Completed or terminated request(s) whose function is taken by this new request.)

status

Enumeration<RequestGroup.RequestStatus> status

The current state of the request. For request groups, the status reflects the status of all the requests in the group.

subject

Reference subject

The subject for which the request group was created.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (The subject for which the request group was created.)

Class org.hl7.fhir.r4.model.RequestGroup.ActionCardinalityBehaviorEnumFactory

class ActionCardinalityBehaviorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.RequestGroup.ActionConditionKindEnumFactory

class ActionConditionKindEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.RequestGroup.ActionGroupingBehaviorEnumFactory

class ActionGroupingBehaviorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.RequestGroup.ActionPrecheckBehaviorEnumFactory

class ActionPrecheckBehaviorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.RequestGroup.ActionRelationshipTypeEnumFactory

class ActionRelationshipTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.RequestGroup.ActionRequiredBehaviorEnumFactory

class ActionRequiredBehaviorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.RequestGroup.ActionSelectionBehaviorEnumFactory

class ActionSelectionBehaviorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.RequestGroup.RequestGroupActionComponent

class RequestGroupActionComponent extends BackboneElement implements Serializable

serialVersionUID:

296752321L

Serialized Fields

action

List<RequestGroup.RequestGroupActionComponent> action

Sub actions.

cardinalityBehavior

Enumeration<RequestGroup.ActionCardinalityBehavior> cardinalityBehavior

Defines whether the action can be selected multiple times.

code

List<CodeableConcept> code

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template.

condition

List<RequestGroup.RequestGroupActionConditionComponent> condition

An expression that describes applicability criteria, or start/stop conditions for the action.

description

StringType description

A short description of the action used to provide a summary to display to the user.

documentation

List<RelatedArtifact> documentation

Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.

groupingBehavior

Enumeration<RequestGroup.ActionGroupingBehavior> groupingBehavior

Defines the grouping behavior for the action and its children.

participant

List<Reference> participant

The participant that should perform or be responsible for this action.

participantTarget

List<Resource> participantTarget

The actual objects that are the target of the reference (The participant that should perform or be responsible for this action.)

precheckBehavior

Enumeration<RequestGroup.ActionPrecheckBehavior> precheckBehavior

Defines whether the action should usually be preselected.

prefix

StringType prefix

A user-visible prefix for the action.

priority

Enumeration<RequestGroup.RequestPriority> priority

Indicates how quickly the action should be addressed with respect to other actions.

relatedAction

List<RequestGroup.RequestGroupActionRelatedActionComponent> relatedAction

A relationship to another action such as "before" or "30-60 minutes after start of".

requiredBehavior

Enumeration<RequestGroup.ActionRequiredBehavior> requiredBehavior

Defines expectations around whether an action is required.

resource

Reference resource

The resource that is the target of the action (e.g. CommunicationRequest).

resourceTarget

Resource resourceTarget

The actual object that is the target of the reference (The resource that is the target of the action (e.g. CommunicationRequest).)

selectionBehavior

Enumeration<RequestGroup.ActionSelectionBehavior> selectionBehavior

Defines the selection behavior for the action and its children.

textEquivalent

StringType textEquivalent

A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.

timing

Type timing

An optional value describing when the action should be performed.

title

StringType title

The title of the action displayed to a user.

type

CodeableConcept type

The type of action to perform (create, update, remove).

Class org.hl7.fhir.r4.model.RequestGroup.RequestGroupActionConditionComponent

class RequestGroupActionConditionComponent extends BackboneElement implements Serializable

serialVersionUID:

-455150438L

Serialized Fields

expression

Expression expression

An expression that returns true or false, indicating whether or not the condition is satisfied.

kind

Enumeration<RequestGroup.ActionConditionKind> kind

The kind of condition.

Class org.hl7.fhir.r4.model.RequestGroup.RequestGroupActionRelatedActionComponent

class RequestGroupActionRelatedActionComponent extends BackboneElement implements Serializable

serialVersionUID:

1063306770L

Serialized Fields

actionId

IdType actionId

The element id of the action this is related to.

offset

Type offset

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

relationship

Enumeration<RequestGroup.ActionRelationshipType> relationship

The relationship of this action to the related action.

Class org.hl7.fhir.r4.model.RequestGroup.RequestIntentEnumFactory

class RequestIntentEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.RequestGroup.RequestPriorityEnumFactory

class RequestPriorityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.RequestGroup.RequestStatusEnumFactory

class RequestStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ResearchDefinition

class ResearchDefinition extends MetadataResource implements Serializable

serialVersionUID:

-867649565L

Serialized Fields

approvalDate

DateType approvalDate

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

author

List<ContactDetail> author

An individiual or organization primarily involved in the creation and maintenance of the content.

comment

List<StringType> comment

A human-readable string to clarify or explain concepts about the resource.

copyright

MarkdownType copyright

A copyright statement relating to the research definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research definition.

editor

List<ContactDetail> editor

An individual or organization primarily responsible for internal coherence of the content.

effectivePeriod

Period effectivePeriod

The period during which the research definition content was or is planned to be in active use.

endorser

List<ContactDetail> endorser

An individual or organization responsible for officially endorsing the content for use in some setting.

exposure

Reference exposure

A reference to a ResearchElementDefinition resource that defines the exposure for the research.

exposureAlternative

Reference exposureAlternative

A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the research.

exposureAlternativeTarget

ResearchElementDefinition exposureAlternativeTarget

The actual object that is the target of the reference (A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the research.)

exposureTarget

ResearchElementDefinition exposureTarget

The actual object that is the target of the reference (A reference to a ResearchElementDefinition resource that defines the exposure for the research.)

identifier

List<Identifier> identifier

A formal identifier that is used to identify this research definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

lastReviewDate

DateType lastReviewDate

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

library

List<CanonicalType> library

A reference to a Library resource containing the formal logic used by the ResearchDefinition.

outcome

Reference outcome

A reference to a ResearchElementDefinition resomece that defines the outcome for the research.

outcomeTarget

ResearchElementDefinition outcomeTarget

The actual object that is the target of the reference (A reference to a ResearchElementDefinition resomece that defines the outcome for the research.)

population

Reference population

A reference to a ResearchElementDefinition resource that defines the population for the research.

populationTarget

ResearchElementDefinition populationTarget

The actual object that is the target of the reference (A reference to a ResearchElementDefinition resource that defines the population for the research.)

purpose

MarkdownType purpose

Explanation of why this research definition is needed and why it has been designed as it has.

relatedArtifact

List<RelatedArtifact> relatedArtifact

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

reviewer

List<ContactDetail> reviewer

An individual or organization primarily responsible for review of some aspect of the content.

shortTitle

StringType shortTitle

The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.

subject

Type subject

The intended subjects for the ResearchDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchDefinition can be anything.

subtitle

StringType subtitle

An explanatory or alternate title for the ResearchDefinition giving additional information about its content.

topic

List<CodeableConcept> topic

Descriptive topics related to the content of the ResearchDefinition. Topics provide a high-level categorization grouping types of ResearchDefinitions that can be useful for filtering and searching.

usage

StringType usage

A detailed description, from a clinical perspective, of how the ResearchDefinition is used.

Class org.hl7.fhir.r4.model.ResearchElementDefinition

class ResearchElementDefinition extends MetadataResource implements Serializable

serialVersionUID:

1483216033L

Serialized Fields

approvalDate

DateType approvalDate

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

author

List<ContactDetail> author

An individiual or organization primarily involved in the creation and maintenance of the content.

characteristic

List<ResearchElementDefinition.ResearchElementDefinitionCharacteristicComponent> characteristic

A characteristic that defines the members of the research element. Multiple characteristics are applied with "and" semantics.

comment

List<StringType> comment

A human-readable string to clarify or explain concepts about the resource.

copyright

MarkdownType copyright

A copyright statement relating to the research element definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research element definition.

editor

List<ContactDetail> editor

An individual or organization primarily responsible for internal coherence of the content.

effectivePeriod

Period effectivePeriod

The period during which the research element definition content was or is planned to be in active use.

endorser

List<ContactDetail> endorser

An individual or organization responsible for officially endorsing the content for use in some setting.

identifier

List<Identifier> identifier

A formal identifier that is used to identify this research element definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

lastReviewDate

DateType lastReviewDate

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

library

List<CanonicalType> library

A reference to a Library resource containing the formal logic used by the ResearchElementDefinition.

purpose

MarkdownType purpose

Explanation of why this research element definition is needed and why it has been designed as it has.

relatedArtifact

List<RelatedArtifact> relatedArtifact

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

reviewer

List<ContactDetail> reviewer

An individual or organization primarily responsible for review of some aspect of the content.

shortTitle

StringType shortTitle

The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.

subject

Type subject

The intended subjects for the ResearchElementDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchElementDefinition can be anything.

subtitle

StringType subtitle

An explanatory or alternate title for the ResearchElementDefinition giving additional information about its content.

topic

List<CodeableConcept> topic

Descriptive topics related to the content of the ResearchElementDefinition. Topics provide a high-level categorization grouping types of ResearchElementDefinitions that can be useful for filtering and searching.

type

Enumeration<ResearchElementDefinition.ResearchElementType> type

The type of research element, a population, an exposure, or an outcome.

usage

StringType usage

A detailed description, from a clinical perspective, of how the ResearchElementDefinition is used.

variableType

Enumeration<ResearchElementDefinition.VariableType> variableType

The type of the outcome (e.g. Dichotomous, Continuous, or Descriptive).

Class org.hl7.fhir.r4.model.ResearchElementDefinition.GroupMeasureEnumFactory

class GroupMeasureEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ResearchElementDefinition.ResearchElementDefinitionCharacteristicComponent

class ResearchElementDefinitionCharacteristicComponent extends BackboneElement implements Serializable

serialVersionUID:

-1102952665L

Serialized Fields

definition

Type definition

Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).

exclude

BooleanType exclude

When true, members with this characteristic are excluded from the element.

participantEffective

Type participantEffective

Indicates what effective period the study covers.

participantEffectiveDescription

StringType participantEffectiveDescription

A narrative description of the time period the study covers.

participantEffectiveGroupMeasure

Enumeration<ResearchElementDefinition.GroupMeasure> participantEffectiveGroupMeasure

Indicates how elements are aggregated within the study effective period.

participantEffectiveTimeFromStart

Duration participantEffectiveTimeFromStart

Indicates duration from the participant's study entry.

studyEffective

Type studyEffective

Indicates what effective period the study covers.

studyEffectiveDescription

StringType studyEffectiveDescription

A narrative description of the time period the study covers.

studyEffectiveGroupMeasure

Enumeration<ResearchElementDefinition.GroupMeasure> studyEffectiveGroupMeasure

Indicates how elements are aggregated within the study effective period.

studyEffectiveTimeFromStart

Duration studyEffectiveTimeFromStart

Indicates duration from the study initiation.

unitOfMeasure

CodeableConcept unitOfMeasure

Specifies the UCUM unit for the outcome.

usageContext

List<UsageContext> usageContext

Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.

Class org.hl7.fhir.r4.model.ResearchElementDefinition.ResearchElementTypeEnumFactory

class ResearchElementTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ResearchElementDefinition.VariableTypeEnumFactory

class VariableTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ResearchStudy

class ResearchStudy extends DomainResource implements Serializable

serialVersionUID:

-911538323L

Serialized Fields

arm

List<ResearchStudy.ResearchStudyArmComponent> arm

Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.

category

List<CodeableConcept> category

Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.

condition

List<CodeableConcept> condition

The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion "healthy volunteer", but the target condition code would be a Lupus SNOMED code.

contact

List<ContactDetail> contact

Contact details to assist a user in learning more about or engaging with the study.

description

MarkdownType description

A full description of how the study is being conducted.

enrollment

List<Reference> enrollment

Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes".

enrollmentTarget

List<Group> enrollmentTarget

The actual objects that are the target of the reference (Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes".)

focus

List<CodeableConcept> focus

The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.

identifier

List<Identifier> identifier

Identifiers assigned to this research study by the sponsor or other systems.

keyword

List<CodeableConcept> keyword

Key terms to aid in searching for or filtering the study.

location

List<CodeableConcept> location

Indicates a country, state or other region where the study is taking place.

note

List<Annotation> note

Comments made about the study by the performer, subject or other participants.

objective

List<ResearchStudy.ResearchStudyObjectiveComponent> objective

A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study.

partOf

List<Reference> partOf

A larger research study of which this particular study is a component or step.

partOfTarget

List<ResearchStudy> partOfTarget

The actual objects that are the target of the reference (A larger research study of which this particular study is a component or step.)

period

Period period

Identifies the start date and the expected (or actual, depending on status) end date for the study.

phase

CodeableConcept phase

The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.

primaryPurposeType

CodeableConcept primaryPurposeType

The type of study based upon the intent of the study's activities. A classification of the intent of the study.

principalInvestigator

Reference principalInvestigator

A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.

principalInvestigatorTarget

Resource principalInvestigatorTarget

The actual object that is the target of the reference (A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.)

protocol

List<Reference> protocol

The set of steps expected to be performed as part of the execution of the study.

protocolTarget

List<PlanDefinition> protocolTarget

The actual objects that are the target of the reference (The set of steps expected to be performed as part of the execution of the study.)

reasonStopped

CodeableConcept reasonStopped

A description and/or code explaining the premature termination of the study.

relatedArtifact

List<RelatedArtifact> relatedArtifact

Citations, references and other related documents.

site

List<Reference> site

A facility in which study activities are conducted.

siteTarget

List<Location> siteTarget

The actual objects that are the target of the reference (A facility in which study activities are conducted.)

sponsor

Reference sponsor

An organization that initiates the investigation and is legally responsible for the study.

sponsorTarget

Organization sponsorTarget

The actual object that is the target of the reference (An organization that initiates the investigation and is legally responsible for the study.)

status

Enumeration<ResearchStudy.ResearchStudyStatus> status

The current state of the study.

title

StringType title

A short, descriptive user-friendly label for the study.

Class org.hl7.fhir.r4.model.ResearchStudy.ResearchStudyArmComponent

class ResearchStudyArmComponent extends BackboneElement implements Serializable

serialVersionUID:

311445244L

Serialized Fields

description

StringType description

A succinct description of the path through the study that would be followed by a subject adhering to this arm.

name

StringType name

Unique, human-readable label for this arm of the study.

type

CodeableConcept type

Categorization of study arm, e.g. experimental, active comparator, placebo comparater.

Class org.hl7.fhir.r4.model.ResearchStudy.ResearchStudyObjectiveComponent

class ResearchStudyObjectiveComponent extends BackboneElement implements Serializable

serialVersionUID:

-1935215997L

Serialized Fields

name

StringType name

Unique, human-readable label for this objective of the study.

type

CodeableConcept type

The kind of study objective.

Class org.hl7.fhir.r4.model.ResearchStudy.ResearchStudyStatusEnumFactory

class ResearchStudyStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ResearchSubject

class ResearchSubject extends DomainResource implements Serializable

serialVersionUID:

-884133739L

Serialized Fields

actualArm

StringType actualArm

The name of the arm in the study the subject actually followed as part of this study.

assignedArm

StringType assignedArm

The name of the arm in the study the subject is expected to follow as part of this study.

consent

Reference consent

A record of the patient's informed agreement to participate in the study.

consentTarget

Consent consentTarget

The actual object that is the target of the reference (A record of the patient's informed agreement to participate in the study.)

identifier

List<Identifier> identifier

Identifiers assigned to this research subject for a study.

individual

Reference individual

The record of the person or animal who is involved in the study.

individualTarget

Patient individualTarget

The actual object that is the target of the reference (The record of the person or animal who is involved in the study.)

period

Period period

The dates the subject began and ended their participation in the study.

status

Enumeration<ResearchSubject.ResearchSubjectStatus> status

The current state of the subject.

study

Reference study

Reference to the study the subject is participating in.

studyTarget

ResearchStudy studyTarget

The actual object that is the target of the reference (Reference to the study the subject is participating in.)

Class org.hl7.fhir.r4.model.ResearchSubject.ResearchSubjectStatusEnumFactory

class ResearchSubjectStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Resource

class Resource extends BaseResource implements Serializable

serialVersionUID:

-559462759L

Serialized Fields

id

IdType id

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

implicitRules

UriType implicitRules

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

language

CodeType language

The base language in which the resource is written.

meta

Meta meta

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Class org.hl7.fhir.r4.model.RiskAssessment

class RiskAssessment extends DomainResource implements Serializable

serialVersionUID:

-2137260218L

Serialized Fields

basedOn

Reference basedOn

A reference to the request that is fulfilled by this risk assessment.

basedOnTarget

Resource basedOnTarget

The actual object that is the target of the reference (A reference to the request that is fulfilled by this risk assessment.)

basis

List<Reference> basis

Indicates the source data considered as part of the assessment (for example, FamilyHistory, Observations, Procedures, Conditions, etc.).

basisTarget

List<Resource> basisTarget

The actual objects that are the target of the reference (Indicates the source data considered as part of the assessment (for example, FamilyHistory, Observations, Procedures, Conditions, etc.).)

code

CodeableConcept code

The type of the risk assessment performed.

condition

Reference condition

For assessments or prognosis specific to a particular condition, indicates the condition being assessed.

conditionTarget

Condition conditionTarget

The actual object that is the target of the reference (For assessments or prognosis specific to a particular condition, indicates the condition being assessed.)

encounter

Reference encounter

The encounter where the assessment was performed.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (The encounter where the assessment was performed.)

identifier

List<Identifier> identifier

Business identifier assigned to the risk assessment.

method

CodeableConcept method

The algorithm, process or mechanism used to evaluate the risk.

mitigation

StringType mitigation

A description of the steps that might be taken to reduce the identified risk(s).

note

List<Annotation> note

Additional comments about the risk assessment.

occurrence

Type occurrence

The date (and possibly time) the risk assessment was performed.

parent

Reference parent

A reference to a resource that this risk assessment is part of, such as a Procedure.

parentTarget

Resource parentTarget

The actual object that is the target of the reference (A reference to a resource that this risk assessment is part of, such as a Procedure.)

performer

Reference performer

The provider or software application that performed the assessment.

performerTarget

Resource performerTarget

The actual object that is the target of the reference (The provider or software application that performed the assessment.)

prediction

List<RiskAssessment.RiskAssessmentPredictionComponent> prediction

Describes the expected outcome for the subject.

reasonCode

List<CodeableConcept> reasonCode

The reason the risk assessment was performed.

reasonReference

List<Reference> reasonReference

Resources supporting the reason the risk assessment was performed.

reasonReferenceTarget

List<Resource> reasonReferenceTarget

The actual objects that are the target of the reference (Resources supporting the reason the risk assessment was performed.)

status

Enumeration<RiskAssessment.RiskAssessmentStatus> status

The status of the RiskAssessment, using the same statuses as an Observation.

subject

Reference subject

The patient or group the risk assessment applies to.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (The patient or group the risk assessment applies to.)

Class org.hl7.fhir.r4.model.RiskAssessment.RiskAssessmentPredictionComponent

class RiskAssessmentPredictionComponent extends BackboneElement implements Serializable

serialVersionUID:

1283401747L

Serialized Fields

outcome

CodeableConcept outcome

One of the potential outcomes for the patient (e.g. remission, death, a particular condition).

probability

Type probability

Indicates how likely the outcome is (in the specified timeframe).

qualitativeRisk

CodeableConcept qualitativeRisk

Indicates how likely the outcome is (in the specified timeframe), expressed as a qualitative value (e.g. low, medium, or high).

rationale

StringType rationale

Additional information explaining the basis for the prediction.

relativeRisk

DecimalType relativeRisk

Indicates the risk for this particular subject (with their specific characteristics) divided by the risk of the population in general. (Numbers greater than 1 = higher risk than the population, numbers less than 1 = lower risk.).

when

Type when

Indicates the period of time or age range of the subject to which the specified probability applies.

Class org.hl7.fhir.r4.model.RiskAssessment.RiskAssessmentStatusEnumFactory

class RiskAssessmentStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.RiskEvidenceSynthesis

class RiskEvidenceSynthesis extends MetadataResource implements Serializable

serialVersionUID:

706492815L

Serialized Fields

approvalDate

DateType approvalDate

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

author

List<ContactDetail> author

An individiual or organization primarily involved in the creation and maintenance of the content.

certainty

List<RiskEvidenceSynthesis.RiskEvidenceSynthesisCertaintyComponent> certainty

A description of the certainty of the risk estimate.

copyright

MarkdownType copyright

A copyright statement relating to the risk evidence synthesis and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the risk evidence synthesis.

editor

List<ContactDetail> editor

An individual or organization primarily responsible for internal coherence of the content.

effectivePeriod

Period effectivePeriod

The period during which the risk evidence synthesis content was or is planned to be in active use.

endorser

List<ContactDetail> endorser

An individual or organization responsible for officially endorsing the content for use in some setting.

exposure

Reference exposure

A reference to a EvidenceVariable resource that defines the exposure for the research.

exposureTarget

EvidenceVariable exposureTarget

The actual object that is the target of the reference (A reference to a EvidenceVariable resource that defines the exposure for the research.)

identifier

List<Identifier> identifier

A formal identifier that is used to identify this risk evidence synthesis when it is represented in other formats, or referenced in a specification, model, design or an instance.

lastReviewDate

DateType lastReviewDate

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

note

List<Annotation> note

A human-readable string to clarify or explain concepts about the resource.

outcome

Reference outcome

A reference to a EvidenceVariable resomece that defines the outcome for the research.

outcomeTarget

EvidenceVariable outcomeTarget

The actual object that is the target of the reference (A reference to a EvidenceVariable resomece that defines the outcome for the research.)

population

Reference population

A reference to a EvidenceVariable resource that defines the population for the research.

populationTarget

EvidenceVariable populationTarget

The actual object that is the target of the reference (A reference to a EvidenceVariable resource that defines the population for the research.)

relatedArtifact

List<RelatedArtifact> relatedArtifact

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

reviewer

List<ContactDetail> reviewer

An individual or organization primarily responsible for review of some aspect of the content.

riskEstimate

RiskEvidenceSynthesis.RiskEvidenceSynthesisRiskEstimateComponent riskEstimate

The estimated risk of the outcome.

sampleSize

RiskEvidenceSynthesis.RiskEvidenceSynthesisSampleSizeComponent sampleSize

A description of the size of the sample involved in the synthesis.

studyType

CodeableConcept studyType

Type of study eg randomized trial.

synthesisType

CodeableConcept synthesisType

Type of synthesis eg meta-analysis.

topic

List<CodeableConcept> topic

Descriptive topics related to the content of the RiskEvidenceSynthesis. Topics provide a high-level categorization grouping types of EffectEvidenceSynthesiss that can be useful for filtering and searching.

Class org.hl7.fhir.r4.model.RiskEvidenceSynthesis.RiskEvidenceSynthesisCertaintyCertaintySubcomponentComponent

class RiskEvidenceSynthesisCertaintyCertaintySubcomponentComponent extends BackboneElement implements Serializable

serialVersionUID:

-411994816L

Serialized Fields

note

List<Annotation> note

A human-readable string to clarify or explain concepts about the resource.

rating

List<CodeableConcept> rating

A rating of a subcomponent of rating certainty.

type

CodeableConcept type

Type of subcomponent of certainty rating.

Class org.hl7.fhir.r4.model.RiskEvidenceSynthesis.RiskEvidenceSynthesisCertaintyComponent

class RiskEvidenceSynthesisCertaintyComponent extends BackboneElement implements Serializable

serialVersionUID:

663360871L

Serialized Fields

certaintySubcomponent

List<RiskEvidenceSynthesis.RiskEvidenceSynthesisCertaintyCertaintySubcomponentComponent> certaintySubcomponent

A description of a component of the overall certainty.

note

List<Annotation> note

A human-readable string to clarify or explain concepts about the resource.

rating

List<CodeableConcept> rating

A rating of the certainty of the effect estimate.

Class org.hl7.fhir.r4.model.RiskEvidenceSynthesis.RiskEvidenceSynthesisRiskEstimateComponent

class RiskEvidenceSynthesisRiskEstimateComponent extends BackboneElement implements Serializable

serialVersionUID:

-15987415L

Serialized Fields

denominatorCount

IntegerType denominatorCount

The sample size for the group that was measured for this risk estimate.

description

StringType description

Human-readable summary of risk estimate.

numeratorCount

IntegerType numeratorCount

The number of group members with the outcome of interest.

precisionEstimate

List<RiskEvidenceSynthesis.RiskEvidenceSynthesisRiskEstimatePrecisionEstimateComponent> precisionEstimate

A description of the precision of the estimate for the effect.

type

CodeableConcept type

Examples include proportion and mean.

unitOfMeasure

CodeableConcept unitOfMeasure

Specifies the UCUM unit for the outcome.

value

DecimalType value

The point estimate of the risk estimate.

Class org.hl7.fhir.r4.model.RiskEvidenceSynthesis.RiskEvidenceSynthesisRiskEstimatePrecisionEstimateComponent

class RiskEvidenceSynthesisRiskEstimatePrecisionEstimateComponent extends BackboneElement implements Serializable

serialVersionUID:

-110178057L

Serialized Fields

from

DecimalType from

Lower bound of confidence interval.

level

DecimalType level

Use 95 for a 95% confidence interval.

to

DecimalType to

Upper bound of confidence interval.

type

CodeableConcept type

Examples include confidence interval and interquartile range.

Class org.hl7.fhir.r4.model.RiskEvidenceSynthesis.RiskEvidenceSynthesisSampleSizeComponent

class RiskEvidenceSynthesisSampleSizeComponent extends BackboneElement implements Serializable

serialVersionUID:

-1116074476L

Serialized Fields

description

StringType description

Human-readable summary of sample size.

numberOfParticipants

IntegerType numberOfParticipants

Number of participants included in this evidence synthesis.

numberOfStudies

IntegerType numberOfStudies

Number of studies included in this evidence synthesis.

Class org.hl7.fhir.r4.model.SampledData

class SampledData extends Type implements Serializable

serialVersionUID:

-1984181262L

Serialized Fields

data

StringType data

A series of data points which are decimal values separated by a single space (character u20). The special values "E" (error), "L" (below detection limit) and "U" (above detection limit) can also be used in place of a decimal value.

dimensions

PositiveIntType dimensions

The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.

factor

DecimalType factor

A correction factor that is applied to the sampled data points before they are added to the origin.

lowerLimit

DecimalType lowerLimit

The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).

origin

Quantity origin

The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series.

period

DecimalType period

The length of time between sampling times, measured in milliseconds.

upperLimit

DecimalType upperLimit

The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).

Class org.hl7.fhir.r4.model.Schedule

class Schedule extends DomainResource implements Serializable

serialVersionUID:

203182600L

Serialized Fields

active

BooleanType active

Whether this schedule record is in active use or should not be used (such as was entered in error).

actor

List<Reference> actor

Slots that reference this schedule resource provide the availability details to these referenced resource(s).

actorTarget

List<Resource> actorTarget

The actual objects that are the target of the reference (Slots that reference this schedule resource provide the availability details to these referenced resource(s).)

comment

StringType comment

Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.

identifier

List<Identifier> identifier

External Ids for this item.

planningHorizon

Period planningHorizon

The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates.

serviceCategory

List<CodeableConcept> serviceCategory

A broad categorization of the service that is to be performed during this appointment.

serviceType

List<CodeableConcept> serviceType

The specific service that is to be performed during this appointment.

specialty

List<CodeableConcept> specialty

The specialty of a practitioner that would be required to perform the service requested in this appointment.

Class org.hl7.fhir.r4.model.SearchParameter

class SearchParameter extends MetadataResource implements Serializable

serialVersionUID:

-533803519L

Serialized Fields

base

List<CodeType> base

The base resource type(s) that this search parameter can be used against.

chain

List<StringType> chain

Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.

code

CodeType code

The code used in the URL or the parameter name in a parameters resource for this search parameter.

comparator

List<Enumeration<SearchParameter.SearchComparator>> comparator

Comparators supported for the search parameter.

component

List<SearchParameter.SearchParameterComponentComponent> component

Used to define the parts of a composite search parameter.

derivedFrom

CanonicalType derivedFrom

Where this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. i.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter.

expression

StringType expression

A FHIRPath expression that returns a set of elements for the search parameter.

modifier

List<Enumeration<SearchParameter.SearchModifierCode>> modifier

A modifier supported for the search parameter.

multipleAnd

BooleanType multipleAnd

Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.

multipleOr

BooleanType multipleOr

Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match.

purpose

MarkdownType purpose

Explanation of why this search parameter is needed and why it has been designed as it has.

target

List<CodeType> target

Types of resource (if a resource is referenced).

type

Enumeration<Enumerations.SearchParamType> type

The type of value that a search parameter may contain, and how the content is interpreted.

xpath

StringType xpath

An XPath expression that returns a set of elements for the search parameter.

xpathUsage

Enumeration<SearchParameter.XPathUsageType> xpathUsage

How the search parameter relates to the set of elements returned by evaluating the xpath query.

Class org.hl7.fhir.r4.model.SearchParameter.SearchComparatorEnumFactory

class SearchComparatorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.SearchParameter.SearchModifierCodeEnumFactory

class SearchModifierCodeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.SearchParameter.SearchParameterComponentComponent

class SearchParameterComponentComponent extends BackboneElement implements Serializable

serialVersionUID:

-1469435618L

Serialized Fields

definition

CanonicalType definition

The definition of the search parameter that describes this part.

expression

StringType expression

A sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expression.

Class org.hl7.fhir.r4.model.SearchParameter.XPathUsageTypeEnumFactory

class XPathUsageTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ServiceRequest

class ServiceRequest extends DomainResource implements Serializable

serialVersionUID:

-1202335045L

Serialized Fields

asNeeded

Type asNeeded

If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.

authoredOn

DateTimeType authoredOn

When the request transitioned to being actionable.

basedOn

List<Reference> basedOn

Plan/proposal/order fulfilled by this request.

basedOnTarget

List<Resource> basedOnTarget

The actual objects that are the target of the reference (Plan/proposal/order fulfilled by this request.)

bodySite

List<CodeableConcept> bodySite

Anatomic location where the procedure should be performed. This is the target site.

category

List<CodeableConcept> category

A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").

code

CodeableConcept code

A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.

doNotPerform

BooleanType doNotPerform

Set this to true if the record is saying that the service/procedure should NOT be performed.

encounter

Reference encounter

An encounter that provides additional information about the healthcare context in which this request is made.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (An encounter that provides additional information about the healthcare context in which this request is made.)

identifier

List<Identifier> identifier

Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.

instantiatesCanonical

List<CanonicalType> instantiatesCanonical

The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.

instantiatesUri

List<UriType> instantiatesUri

The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.

insurance

List<Reference> insurance

Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.

insuranceTarget

List<Resource> insuranceTarget

The actual objects that are the target of the reference (Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.)

intent

Enumeration<ServiceRequest.ServiceRequestIntent> intent

Whether the request is a proposal, plan, an original order or a reflex order.

locationCode

List<CodeableConcept> locationCode

The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center.

locationReference

List<Reference> locationReference

A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.

locationReferenceTarget

List<Location> locationReferenceTarget

The actual objects that are the target of the reference (A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.)

note

List<Annotation> note

Any other notes and comments made about the service request. For example, internal billing notes.

occurrence

Type occurrence

The date/time at which the requested service should occur.

orderDetail

List<CodeableConcept> orderDetail

Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied.

patientInstruction

StringType patientInstruction

Instructions in terms that are understood by the patient or consumer.

performer

List<Reference> performer

The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.

performerTarget

List<Resource> performerTarget

The actual objects that are the target of the reference (The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.)

performerType

CodeableConcept performerType

Desired type of performer for doing the requested service.

priority

Enumeration<ServiceRequest.ServiceRequestPriority> priority

Indicates how quickly the ServiceRequest should be addressed with respect to other requests.

quantity

Type quantity

An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).

reasonCode

List<CodeableConcept> reasonCode

An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in `supportingInfo`.

reasonReference

List<Reference> reasonReference

Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`.

reasonReferenceTarget

List<Resource> reasonReferenceTarget

The actual objects that are the target of the reference (Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`.)

relevantHistory

List<Reference> relevantHistory

Key events in the history of the request.

relevantHistoryTarget

List<Provenance> relevantHistoryTarget

The actual objects that are the target of the reference (Key events in the history of the request.)

replaces

List<Reference> replaces

The request takes the place of the referenced completed or terminated request(s).

replacesTarget

List<ServiceRequest> replacesTarget

The actual objects that are the target of the reference (The request takes the place of the referenced completed or terminated request(s).)

requester

Reference requester

The individual who initiated the request and has responsibility for its activation.

requesterTarget

Resource requesterTarget

The actual object that is the target of the reference (The individual who initiated the request and has responsibility for its activation.)

requisition

Identifier requisition

A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.

specimen

List<Reference> specimen

One or more specimens that the laboratory procedure will use.

specimenTarget

List<Specimen> specimenTarget

The actual objects that are the target of the reference (One or more specimens that the laboratory procedure will use.)

status

Enumeration<ServiceRequest.ServiceRequestStatus> status

The status of the order.

subject

Reference subject

On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).)

supportingInfo

List<Reference> supportingInfo

Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.

supportingInfoTarget

List<Resource> supportingInfoTarget

The actual objects that are the target of the reference (Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.)

Class org.hl7.fhir.r4.model.ServiceRequest.ServiceRequestIntentEnumFactory

class ServiceRequestIntentEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ServiceRequest.ServiceRequestPriorityEnumFactory

class ServiceRequestPriorityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ServiceRequest.ServiceRequestStatusEnumFactory

class ServiceRequestStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.SidType

class SidType extends UriType implements Externalizable

serialVersionUID:

5486832330986493589L

Serialization Methods

readExternal

public void readExternal(ObjectInput theIn)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput theOut)
                   throws IOException

Throws:

IOException

Class org.hl7.fhir.r4.model.Signature

class Signature extends Type implements Serializable

serialVersionUID:

1587325823L

Serialized Fields

data

Base64BinaryType data

The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.

onBehalfOf

Reference onBehalfOf

A reference to an application-usable description of the identity that is represented by the signature.

onBehalfOfTarget

Resource onBehalfOfTarget

The actual object that is the target of the reference (A reference to an application-usable description of the identity that is represented by the signature.)

sigFormat

CodeType sigFormat

A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.

targetFormat

CodeType targetFormat

A mime type that indicates the technical format of the target resources signed by the signature.

type

List<Coding> type

An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.

when

InstantType when

When the digital signature was signed.

who

Reference who

A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).

whoTarget

Resource whoTarget

The actual object that is the target of the reference (A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).)

Class org.hl7.fhir.r4.model.SimpleQuantity

class SimpleQuantity extends Quantity implements Serializable

serialVersionUID:

1069574054L

Class org.hl7.fhir.r4.model.Slot

class Slot extends DomainResource implements Serializable

serialVersionUID:

683481856L

Serialized Fields

appointmentType

CodeableConcept appointmentType

The style of appointment or patient that may be booked in the slot (not service type).

comment

StringType comment

Comments on the slot to describe any extended information. Such as custom constraints on the slot.

end

InstantType end

Date/Time that the slot is to conclude.

identifier

List<Identifier> identifier

External Ids for this item.

overbooked

BooleanType overbooked

This slot has already been overbooked, appointments are unlikely to be accepted for this time.

schedule

Reference schedule

The schedule resource that this slot defines an interval of status information.

scheduleTarget

Schedule scheduleTarget

The actual object that is the target of the reference (The schedule resource that this slot defines an interval of status information.)

serviceCategory

List<CodeableConcept> serviceCategory

A broad categorization of the service that is to be performed during this appointment.

serviceType

List<CodeableConcept> serviceType

The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource.

specialty

List<CodeableConcept> specialty

The specialty of a practitioner that would be required to perform the service requested in this appointment.

start

InstantType start

Date/Time that the slot is to begin.

status

Enumeration<Slot.SlotStatus> status

busy | free | busy-unavailable | busy-tentative | entered-in-error.

Class org.hl7.fhir.r4.model.Slot.SlotStatusEnumFactory

class SlotStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Specimen

class Specimen extends DomainResource implements Serializable

serialVersionUID:

1441502239L

Serialized Fields

accessionIdentifier

Identifier accessionIdentifier

The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.

collection

Specimen.SpecimenCollectionComponent collection

Details concerning the specimen collection.

condition

List<CodeableConcept> condition

A mode or state of being that describes the nature of the specimen.

container

List<Specimen.SpecimenContainerComponent> container

The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.

identifier

List<Identifier> identifier

Id for specimen.

note

List<Annotation> note

To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).

parent

List<Reference> parent

Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.

parentTarget

List<Specimen> parentTarget

The actual objects that are the target of the reference (Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.)

processing

List<Specimen.SpecimenProcessingComponent> processing

Details concerning processing and processing steps for the specimen.

receivedTime

DateTimeType receivedTime

Time when specimen was received for processing or testing.

request

List<Reference> request

Details concerning a service request that required a specimen to be collected.

requestTarget

List<ServiceRequest> requestTarget

The actual objects that are the target of the reference (Details concerning a service request that required a specimen to be collected.)

status

Enumeration<Specimen.SpecimenStatus> status

The availability of the specimen.

subject

Reference subject

Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.

subjectTarget

Resource subjectTarget

The actual object that is the target of the reference (Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.)

type

CodeableConcept type

The kind of material that forms the specimen.

Class org.hl7.fhir.r4.model.Specimen.SpecimenCollectionComponent

class SpecimenCollectionComponent extends BackboneElement implements Serializable

serialVersionUID:

-719430195L

Serialized Fields

bodySite

CodeableConcept bodySite

Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.

collected

Type collected

Time when specimen was collected from subject - the physiologically relevant time.

collector

Reference collector

Person who collected the specimen.

collectorTarget

Resource collectorTarget

The actual object that is the target of the reference (Person who collected the specimen.)

duration

Duration duration

The span of time over which the collection of a specimen occurred.

fastingStatus

Type fastingStatus

Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.

method

CodeableConcept method

A coded value specifying the technique that is used to perform the procedure.

quantity

Quantity quantity

The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.

Class org.hl7.fhir.r4.model.Specimen.SpecimenContainerComponent

class SpecimenContainerComponent extends BackboneElement implements Serializable

serialVersionUID:

-1608132325L

Serialized Fields

additive

Type additive

Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.

capacity

Quantity capacity

The capacity (volume or other measure) the container may contain.

description

StringType description

Textual description of the container.

identifier

List<Identifier> identifier

Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.

specimenQuantity

Quantity specimenQuantity

The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.

type

CodeableConcept type

The type of container associated with the specimen (e.g. slide, aliquot, etc.).

Class org.hl7.fhir.r4.model.Specimen.SpecimenProcessingComponent

class SpecimenProcessingComponent extends BackboneElement implements Serializable

serialVersionUID:

1467214742L

Serialized Fields

additive

List<Reference> additive

Material used in the processing step.

additiveTarget

List<Substance> additiveTarget

The actual objects that are the target of the reference (Material used in the processing step.)

description

StringType description

Textual description of procedure.

procedure

CodeableConcept procedure

A coded value specifying the procedure used to process the specimen.

time

Type time

A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin.

Class org.hl7.fhir.r4.model.Specimen.SpecimenStatusEnumFactory

class SpecimenStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.SpecimenDefinition

class SpecimenDefinition extends DomainResource implements Serializable

serialVersionUID:

-330188872L

Serialized Fields

collection

List<CodeableConcept> collection

The action to be performed for collecting the specimen.

identifier

Identifier identifier

A business identifier associated with the kind of specimen.

patientPreparation

List<CodeableConcept> patientPreparation

Preparation of the patient for specimen collection.

timeAspect

StringType timeAspect

Time aspect of specimen collection (duration or offset).

typeCollected

CodeableConcept typeCollected

The kind of material to be collected.

typeTested

List<SpecimenDefinition.SpecimenDefinitionTypeTestedComponent> typeTested

Specimen conditioned in a container as expected by the testing laboratory.

Class org.hl7.fhir.r4.model.SpecimenDefinition.SpecimenContainedPreferenceEnumFactory

class SpecimenContainedPreferenceEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.SpecimenDefinition.SpecimenDefinitionTypeTestedComponent

class SpecimenDefinitionTypeTestedComponent extends BackboneElement implements Serializable

serialVersionUID:

308313920L

Serialized Fields

container

SpecimenDefinition.SpecimenDefinitionTypeTestedContainerComponent container

The specimen's container.

handling

List<SpecimenDefinition.SpecimenDefinitionTypeTestedHandlingComponent> handling

Set of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing process.

isDerived

BooleanType isDerived

Primary of secondary specimen.

preference

Enumeration<SpecimenDefinition.SpecimenContainedPreference> preference

The preference for this type of conditioned specimen.

rejectionCriterion

List<CodeableConcept> rejectionCriterion

Criterion for rejection of the specimen in its container by the laboratory.

requirement

StringType requirement

Requirements for delivery and special handling of this kind of conditioned specimen.

retentionTime

Duration retentionTime

The usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing.

type

CodeableConcept type

The kind of specimen conditioned for testing expected by lab.

Class org.hl7.fhir.r4.model.SpecimenDefinition.SpecimenDefinitionTypeTestedContainerAdditiveComponent

class SpecimenDefinitionTypeTestedContainerAdditiveComponent extends BackboneElement implements Serializable

serialVersionUID:

1819209272L

Serialized Fields

additive

Type additive

Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.

Class org.hl7.fhir.r4.model.SpecimenDefinition.SpecimenDefinitionTypeTestedContainerComponent

class SpecimenDefinitionTypeTestedContainerComponent extends BackboneElement implements Serializable

serialVersionUID:

175789710L

Serialized Fields

additive

List<SpecimenDefinition.SpecimenDefinitionTypeTestedContainerAdditiveComponent> additive

Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.

cap

CodeableConcept cap

Color of container cap.

capacity

Quantity capacity

The capacity (volume or other measure) of this kind of container.

description

StringType description

The textual description of the kind of container.

material

CodeableConcept material

The type of material of the container.

minimumVolume

Type minimumVolume

The minimum volume to be conditioned in the container.

preparation

StringType preparation

Special processing that should be applied to the container for this kind of specimen.

type

CodeableConcept type

The type of container used to contain this kind of specimen.

Class org.hl7.fhir.r4.model.SpecimenDefinition.SpecimenDefinitionTypeTestedHandlingComponent

class SpecimenDefinitionTypeTestedHandlingComponent extends BackboneElement implements Serializable

serialVersionUID:

2130906844L

Serialized Fields

instruction

StringType instruction

Additional textual instructions for the preservation or transport of the specimen. For instance, 'Protect from light exposure'.

maxDuration

Duration maxDuration

The maximum time interval of preservation of the specimen with these conditions.

temperatureQualifier

CodeableConcept temperatureQualifier

It qualifies the interval of temperature, which characterizes an occurrence of handling. Conditions that are not related to temperature may be handled in the instruction element.

temperatureRange

Range temperatureRange

The temperature interval for this set of handling instructions.

Class org.hl7.fhir.r4.model.StringType

class StringType extends PrimitiveType<String> implements Externalizable

serialVersionUID:

3L

Serialization Methods

readExternal

public void readExternal(ObjectInput theIn)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput theOut)
                   throws IOException

Throws:

IOException

Class org.hl7.fhir.r4.model.StructureDefinition

class StructureDefinition extends MetadataResource implements Serializable

serialVersionUID:

316076774L

Serialized Fields

abstract_

BooleanType abstract_

Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.

baseDefinition

CanonicalType baseDefinition

An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.

context

List<StructureDefinition.StructureDefinitionContextComponent> context

Identifies the types of resource or data type elements to which the extension can be applied.

contextInvariant

List<StringType> contextInvariant

A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true.

copyright

MarkdownType copyright

A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure definition.

derivation

Enumeration<StructureDefinition.TypeDerivationRule> derivation

How the type relates to the baseDefinition.

differential

StructureDefinition.StructureDefinitionDifferentialComponent differential

A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.

fhirVersion

Enumeration<Enumerations.FHIRVersion> fhirVersion

The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.1. for this version.

identifier

List<Identifier> identifier

A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

keyword

List<Coding> keyword

A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates nby describing the use of this structure definition, or the content it describes.

kind

Enumeration<StructureDefinition.StructureDefinitionKind> kind

Defines the kind of structure that this definition is describing.

mapping

List<StructureDefinition.StructureDefinitionMappingComponent> mapping

An external specification that the content is mapped to.

purpose

MarkdownType purpose

Explanation of why this structure definition is needed and why it has been designed as it has.

snapshot

StructureDefinition.StructureDefinitionSnapshotComponent snapshot

A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.

type

UriType type

The type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type). References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. "string" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.

Class org.hl7.fhir.r4.model.StructureDefinition.ExtensionContextTypeEnumFactory

class ExtensionContextTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.StructureDefinition.StructureDefinitionContextComponent

class StructureDefinitionContextComponent extends BackboneElement implements Serializable

serialVersionUID:

1958074856L

Serialized Fields

expression

StringType expression

An expression that defines where an extension can be used in resources.

type

Enumeration<StructureDefinition.ExtensionContextType> type

Defines how to interpret the expression that defines what the context of the extension is.

Class org.hl7.fhir.r4.model.StructureDefinition.StructureDefinitionDifferentialComponent

class StructureDefinitionDifferentialComponent extends BackboneElement implements Serializable

serialVersionUID:

53896641L

Serialized Fields

element

List<ElementDefinition> element

Captures constraints on each element within the resource.

Class org.hl7.fhir.r4.model.StructureDefinition.StructureDefinitionKindEnumFactory

class StructureDefinitionKindEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.StructureDefinition.StructureDefinitionMappingComponent

class StructureDefinitionMappingComponent extends BackboneElement implements Serializable

serialVersionUID:

9610265L

Serialized Fields

comment

StringType comment

Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.

identity

IdType identity

An Internal id that is used to identify this mapping set when specific mappings are made.

name

StringType name

A name for the specification that is being mapped to.

uri

UriType uri

An absolute URI that identifies the specification that this mapping is expressed to.

Class org.hl7.fhir.r4.model.StructureDefinition.StructureDefinitionSnapshotComponent

class StructureDefinitionSnapshotComponent extends BackboneElement implements Serializable

serialVersionUID:

53896641L

Serialized Fields

element

List<ElementDefinition> element

Captures constraints on each element within the resource.

Class org.hl7.fhir.r4.model.StructureDefinition.TypeDerivationRuleEnumFactory

class TypeDerivationRuleEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.StructureMap

class StructureMap extends MetadataResource implements Serializable

serialVersionUID:

263060597L

Serialized Fields

copyright

MarkdownType copyright

A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure map.

group

List<StructureMap.StructureMapGroupComponent> group

Organizes the mapping into manageable chunks for human review/ease of maintenance.

identifier

List<Identifier> identifier

A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instance.

import_

List<CanonicalType> import_

Other maps used by this map (canonical URLs).

purpose

MarkdownType purpose

Explanation of why this structure map is needed and why it has been designed as it has.

structure

List<StructureMap.StructureMapStructureComponent> structure

A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.

Class org.hl7.fhir.r4.model.StructureMap.StructureMapContextTypeEnumFactory

class StructureMapContextTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.StructureMap.StructureMapGroupComponent

class StructureMapGroupComponent extends BackboneElement implements Serializable

serialVersionUID:

-1474595081L

Serialized Fields

documentation

StringType documentation

Additional supporting documentation that explains the purpose of the group and the types of mappings within it.

extends_

IdType extends_

Another group that this group adds rules to.

input

List<StructureMap.StructureMapGroupInputComponent> input

A name assigned to an instance of data. The instance must be provided when the mapping is invoked.

name

IdType name

A unique name for the group for the convenience of human readers.

rule

List<StructureMap.StructureMapGroupRuleComponent> rule

Transform Rule from source to target.

typeMode

Enumeration<StructureMap.StructureMapGroupTypeMode> typeMode

If this is the default rule set to apply for the source type or this combination of types.

Class org.hl7.fhir.r4.model.StructureMap.StructureMapGroupInputComponent

class StructureMapGroupInputComponent extends BackboneElement implements Serializable

serialVersionUID:

-25050724L

Serialized Fields

documentation

StringType documentation

Documentation for this instance of data.

mode

Enumeration<StructureMap.StructureMapInputMode> mode

Mode for this instance of data.

name

IdType name

Name for this instance of data.

type

StringType type

Type for this instance of data.

Class org.hl7.fhir.r4.model.StructureMap.StructureMapGroupRuleComponent

class StructureMapGroupRuleComponent extends BackboneElement implements Serializable

serialVersionUID:

773925517L

Serialized Fields

dependent

List<StructureMap.StructureMapGroupRuleDependentComponent> dependent

Which other rules to apply in the context of this rule.

documentation

StringType documentation

Documentation for this instance of data.

name

IdType name

Name of the rule for internal references.

rule

List<StructureMap.StructureMapGroupRuleComponent> rule

Rules contained in this rule.

source

List<StructureMap.StructureMapGroupRuleSourceComponent> source

Source inputs to the mapping.

target

List<StructureMap.StructureMapGroupRuleTargetComponent> target

Content to create because of this mapping rule.

Class org.hl7.fhir.r4.model.StructureMap.StructureMapGroupRuleDependentComponent

class StructureMapGroupRuleDependentComponent extends BackboneElement implements Serializable

serialVersionUID:

1021661591L

Serialized Fields

name

IdType name

Name of a rule or group to apply.

variable

List<StringType> variable

Variable to pass to the rule or group.

Class org.hl7.fhir.r4.model.StructureMap.StructureMapGroupRuleSourceComponent

class StructureMapGroupRuleSourceComponent extends BackboneElement implements Serializable

serialVersionUID:

736427977L

Serialized Fields

check

StringType check

FHIRPath expression - must be true or the mapping engine throws an error instead of completing.

condition

StringType condition

FHIRPath expression - must be true or the rule does not apply.

context

IdType context

Type or variable this rule applies to.

defaultValue

Type defaultValue

A value to use if there is no existing value in the source object.

element

StringType element

Optional field for this source.

listMode

Enumeration<StructureMap.StructureMapSourceListMode> listMode

How to handle the list mode for this element.

logMessage

StringType logMessage

A FHIRPath expression which specifies a message to put in the transform log when content matching the source rule is found.

max

StringType max

Specified maximum cardinality for the element - a number or a "*". This is optional; if present, it acts an implicit check on the input content (* just serves as documentation; it's the default value).

min

IntegerType min

Specified minimum cardinality for the element. This is optional; if present, it acts an implicit check on the input content.

type

StringType type

Specified type for the element. This works as a condition on the mapping - use for polymorphic elements.

variable

IdType variable

Named context for field, if a field is specified.

Class org.hl7.fhir.r4.model.StructureMap.StructureMapGroupRuleTargetComponent

class StructureMapGroupRuleTargetComponent extends BackboneElement implements Serializable

serialVersionUID:

-1441766429L

Serialized Fields

context

IdType context

Type or variable this rule applies to.

contextType

Enumeration<StructureMap.StructureMapContextType> contextType

How to interpret the context.

element

StringType element

Field to create in the context.

listMode

List<Enumeration<StructureMap.StructureMapTargetListMode>> listMode

If field is a list, how to manage the list.

listRuleId

IdType listRuleId

Internal rule reference for shared list items.

parameter

List<StructureMap.StructureMapGroupRuleTargetParameterComponent> parameter

Parameters to the transform.

transform

Enumeration<StructureMap.StructureMapTransform> transform

How the data is copied / created.

variable

IdType variable

Named context for field, if desired, and a field is specified.

Class org.hl7.fhir.r4.model.StructureMap.StructureMapGroupRuleTargetParameterComponent

class StructureMapGroupRuleTargetParameterComponent extends BackboneElement implements Serializable

serialVersionUID:

-732981989L

Serialized Fields

value

Type value

Parameter value - variable or literal.

Class org.hl7.fhir.r4.model.StructureMap.StructureMapGroupTypeModeEnumFactory

class StructureMapGroupTypeModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.StructureMap.StructureMapInputModeEnumFactory

class StructureMapInputModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.StructureMap.StructureMapModelModeEnumFactory

class StructureMapModelModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.StructureMap.StructureMapSourceListModeEnumFactory

class StructureMapSourceListModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.StructureMap.StructureMapStructureComponent

class StructureMapStructureComponent extends BackboneElement implements Serializable

serialVersionUID:

364750586L

Serialized Fields

alias

StringType alias

The name used for this type in the map.

documentation

StringType documentation

Documentation that describes how the structure is used in the mapping.

mode

Enumeration<StructureMap.StructureMapModelMode> mode

How the referenced structure is used in this mapping.

url

CanonicalType url

The canonical reference to the structure.

Class org.hl7.fhir.r4.model.StructureMap.StructureMapTargetListModeEnumFactory

class StructureMapTargetListModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.StructureMap.StructureMapTransformEnumFactory

class StructureMapTransformEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Subscription

class Subscription extends DomainResource implements Serializable

serialVersionUID:

1072504988L

Serialized Fields

channel

Subscription.SubscriptionChannelComponent channel

Details where to send notifications when resources are received that meet the criteria.

contact

List<ContactPoint> contact

Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.

criteria

StringType criteria

The rules that the server should use to determine when to generate notifications for this subscription.

end

InstantType end

The time for the server to turn the subscription off.

error

StringType error

A record of the last error that occurred when the server processed a notification.

reason

StringType reason

A description of why this subscription is defined.

status

Enumeration<Subscription.SubscriptionStatus> status

The status of the subscription, which marks the server state for managing the subscription.

Class org.hl7.fhir.r4.model.Subscription.SubscriptionChannelComponent

class SubscriptionChannelComponent extends BackboneElement implements Serializable

serialVersionUID:

-771044852L

Serialized Fields

endpoint

UrlType endpoint

The url that describes the actual end-point to send messages to.

header

List<StringType> header

Additional headers / information to send as part of the notification.

payload

CodeType payload

The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification. The mime type "text/plain" may also be used for Email and SMS subscriptions.

type

Enumeration<Subscription.SubscriptionChannelType> type

The type of channel to send notifications on.

Class org.hl7.fhir.r4.model.Subscription.SubscriptionChannelTypeEnumFactory

class SubscriptionChannelTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Subscription.SubscriptionStatusEnumFactory

class SubscriptionStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Substance

class Substance extends DomainResource implements Serializable

serialVersionUID:

-1467626602L

Serialized Fields

category

List<CodeableConcept> category

A code that classifies the general type of substance. This is used for searching, sorting and display purposes.

code

CodeableConcept code

A code (or set of codes) that identify this substance.

description

StringType description

A description of the substance - its appearance, handling requirements, and other usage notes.

identifier

List<Identifier> identifier

Unique identifier for the substance.

ingredient

List<Substance.SubstanceIngredientComponent> ingredient

A substance can be composed of other substances.

instance

List<Substance.SubstanceInstanceComponent> instance

Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.

status

Enumeration<Substance.FHIRSubstanceStatus> status

A code to indicate if the substance is actively used.

Class org.hl7.fhir.r4.model.Substance.FHIRSubstanceStatusEnumFactory

class FHIRSubstanceStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Substance.SubstanceIngredientComponent

class SubstanceIngredientComponent extends BackboneElement implements Serializable

serialVersionUID:

-469805322L

Serialized Fields

quantity

Ratio quantity

The amount of the ingredient in the substance - a concentration ratio.

substance

Type substance

Another substance that is a component of this substance.

Class org.hl7.fhir.r4.model.Substance.SubstanceInstanceComponent

class SubstanceInstanceComponent extends BackboneElement implements Serializable

serialVersionUID:

-1474380480L

Serialized Fields

expiry

DateTimeType expiry

When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.

identifier

Identifier identifier

Identifier associated with the package/container (usually a label affixed directly).

quantity

Quantity quantity

The amount of the substance.

Class org.hl7.fhir.r4.model.SubstanceAmount

class SubstanceAmount extends BackboneType implements Serializable

serialVersionUID:

-174997548L

Serialized Fields

amount

Type amount

Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.

amountText

StringType amountText

A textual comment on a numeric value.

amountType

CodeableConcept amountType

Most elements that require a quantitative value will also have a field called amount type. Amount type should always be specified because the actual value of the amount is often dependent on it. EXAMPLE: In capturing the actual relative amounts of substances or molecular fragments it is essential to indicate whether the amount refers to a mole ratio or weight ratio. For any given element an effort should be made to use same the amount type for all related definitional elements.

referenceRange

SubstanceAmount.SubstanceAmountReferenceRangeComponent referenceRange

Reference range of possible or expected values.

Class org.hl7.fhir.r4.model.SubstanceAmount.SubstanceAmountReferenceRangeComponent

class SubstanceAmountReferenceRangeComponent extends Element implements Serializable

serialVersionUID:

-193230412L

Serialized Fields

highLimit

Quantity highLimit

Upper limit possible or expected.

lowLimit

Quantity lowLimit

Lower limit possible or expected.

Class org.hl7.fhir.r4.model.SubstanceNucleicAcid

class SubstanceNucleicAcid extends DomainResource implements Serializable

serialVersionUID:

-1906822433L

Serialized Fields

areaOfHybridisation

StringType areaOfHybridisation

The area of hybridisation shall be described if applicable for double stranded RNA or DNA. The number associated with the subunit followed by the number associated to the residue shall be specified in increasing order. The underscore ?? shall be used as separator as follows: ?Subunitnumber Residue?.

numberOfSubunits

IntegerType numberOfSubunits

The number of linear sequences of nucleotides linked through phosphodiester bonds shall be described. Subunits would be strands of nucleic acids that are tightly associated typically through Watson-Crick base pairing. NOTE: If not specified in the reference source, the assumption is that there is 1 subunit.

oligoNucleotideType

CodeableConcept oligoNucleotideType

(TBC).

sequenceType

CodeableConcept sequenceType

The type of the sequence shall be specified based on a controlled vocabulary.

subunit

List<SubstanceNucleicAcid.SubstanceNucleicAcidSubunitComponent> subunit

Subunits are listed in order of decreasing length; sequences of the same length will be ordered by molecular weight; subunits that have identical sequences will be repeated multiple times.

Class org.hl7.fhir.r4.model.SubstanceNucleicAcid.SubstanceNucleicAcidSubunitComponent

class SubstanceNucleicAcidSubunitComponent extends BackboneElement implements Serializable

serialVersionUID:

1835593659L

Serialized Fields

fivePrime

CodeableConcept fivePrime

The nucleotide present at the 5? terminal shall be specified based on a controlled vocabulary. Since the sequence is represented from the 5' to the 3' end, the 5? prime nucleotide is the letter at the first position in the sequence. A separate representation would be redundant.

length

IntegerType length

The length of the sequence shall be captured.

linkage

List<SubstanceNucleicAcid.SubstanceNucleicAcidSubunitLinkageComponent> linkage

The linkages between sugar residues will also be captured.

sequence

StringType sequence

Actual nucleotide sequence notation from 5' to 3' end using standard single letter codes. In addition to the base sequence, sugar and type of phosphate or non-phosphate linkage should also be captured.

sequenceAttachment

Attachment sequenceAttachment

(TBC).

subunit

IntegerType subunit

Index of linear sequences of nucleic acids in order of decreasing length. Sequences of the same length will be ordered by molecular weight. Subunits that have identical sequences will be repeated and have sequential subscripts.

sugar

List<SubstanceNucleicAcid.SubstanceNucleicAcidSubunitSugarComponent> sugar

5.3.6.8.1 Sugar ID (Mandatory).

threePrime

CodeableConcept threePrime

The nucleotide present at the 3? terminal shall be specified based on a controlled vocabulary. Since the sequence is represented from the 5' to the 3' end, the 5? prime nucleotide is the letter at the last position in the sequence. A separate representation would be redundant.

Class org.hl7.fhir.r4.model.SubstanceNucleicAcid.SubstanceNucleicAcidSubunitLinkageComponent

class SubstanceNucleicAcidSubunitLinkageComponent extends BackboneElement implements Serializable

serialVersionUID:

1392155799L

Serialized Fields

connectivity

StringType connectivity

The entity that links the sugar residues together should also be captured for nearly all naturally occurring nucleic acid the linkage is a phosphate group. For many synthetic oligonucleotides phosphorothioate linkages are often seen. Linkage connectivity is assumed to be 3?-5?. If the linkage is either 3?-3? or 5?-5? this should be specified.

identifier

Identifier identifier

Each linkage will be registered as a fragment and have an ID.

name

StringType name

Each linkage will be registered as a fragment and have at least one name. A single name shall be assigned to each linkage.

residueSite

StringType residueSite

Residues shall be captured as described in 5.3.6.8.3.

Class org.hl7.fhir.r4.model.SubstanceNucleicAcid.SubstanceNucleicAcidSubunitSugarComponent

class SubstanceNucleicAcidSubunitSugarComponent extends BackboneElement implements Serializable

serialVersionUID:

1933713781L

Serialized Fields

identifier

Identifier identifier

The Substance ID of the sugar or sugar-like component that make up the nucleotide.

name

StringType name

The name of the sugar or sugar-like component that make up the nucleotide.

residueSite

StringType residueSite

The residues that contain a given sugar will be captured. The order of given residues will be captured in the 5?-3?direction consistent with the base sequences listed above.

Class org.hl7.fhir.r4.model.SubstancePolymer

class SubstancePolymer extends DomainResource implements Serializable

serialVersionUID:

-58301650L

Serialized Fields

class_

CodeableConcept class_

Todo.

copolymerConnectivity

List<CodeableConcept> copolymerConnectivity

Todo.

geometry

CodeableConcept geometry

Todo.

modification

List<StringType> modification

Todo.

monomerSet

List<SubstancePolymer.SubstancePolymerMonomerSetComponent> monomerSet

Todo.

repeat

List<SubstancePolymer.SubstancePolymerRepeatComponent> repeat

Todo.

Class org.hl7.fhir.r4.model.SubstancePolymer.SubstancePolymerMonomerSetComponent

class SubstancePolymerMonomerSetComponent extends BackboneElement implements Serializable

serialVersionUID:

-933825014L

Serialized Fields

ratioType

CodeableConcept ratioType

Todo.

startingMaterial

List<SubstancePolymer.SubstancePolymerMonomerSetStartingMaterialComponent> startingMaterial

Todo.

Class org.hl7.fhir.r4.model.SubstancePolymer.SubstancePolymerMonomerSetStartingMaterialComponent

class SubstancePolymerMonomerSetStartingMaterialComponent extends BackboneElement implements Serializable

serialVersionUID:

589614045L

Serialized Fields

amount

SubstanceAmount amount

Todo.

isDefining

BooleanType isDefining

Todo.

material

CodeableConcept material

Todo.

type

CodeableConcept type

Todo.

Class org.hl7.fhir.r4.model.SubstancePolymer.SubstancePolymerRepeatComponent

class SubstancePolymerRepeatComponent extends BackboneElement implements Serializable

serialVersionUID:

-988147059L

Serialized Fields

averageMolecularFormula

StringType averageMolecularFormula

Todo.

numberOfUnits

IntegerType numberOfUnits

Todo.

repeatUnit

List<SubstancePolymer.SubstancePolymerRepeatRepeatUnitComponent> repeatUnit

Todo.

repeatUnitAmountType

CodeableConcept repeatUnitAmountType

Todo.

Class org.hl7.fhir.r4.model.SubstancePolymer.SubstancePolymerRepeatRepeatUnitComponent

class SubstancePolymerRepeatRepeatUnitComponent extends BackboneElement implements Serializable

serialVersionUID:

-1823741061L

Serialized Fields

amount

SubstanceAmount amount

Todo.

degreeOfPolymerisation

List<SubstancePolymer.SubstancePolymerRepeatRepeatUnitDegreeOfPolymerisationComponent> degreeOfPolymerisation

Todo.

orientationOfPolymerisation

CodeableConcept orientationOfPolymerisation

Todo.

repeatUnit

StringType repeatUnit

Todo.

structuralRepresentation

List<SubstancePolymer.SubstancePolymerRepeatRepeatUnitStructuralRepresentationComponent> structuralRepresentation

Todo.

Class org.hl7.fhir.r4.model.SubstancePolymer.SubstancePolymerRepeatRepeatUnitDegreeOfPolymerisationComponent

class SubstancePolymerRepeatRepeatUnitDegreeOfPolymerisationComponent extends BackboneElement implements Serializable

serialVersionUID:

-1487452773L

Serialized Fields

amount

SubstanceAmount amount

Todo.

degree

CodeableConcept degree

Todo.

Class org.hl7.fhir.r4.model.SubstancePolymer.SubstancePolymerRepeatRepeatUnitStructuralRepresentationComponent

class SubstancePolymerRepeatRepeatUnitStructuralRepresentationComponent extends BackboneElement implements Serializable

serialVersionUID:

167954495L

Serialized Fields

attachment

Attachment attachment

Todo.

representation

StringType representation

Todo.

type

CodeableConcept type

Todo.

Class org.hl7.fhir.r4.model.SubstanceProtein

class SubstanceProtein extends DomainResource implements Serializable

serialVersionUID:

469786856L

Serialized Fields

disulfideLinkage

List<StringType> disulfideLinkage

The disulphide bond between two cysteine residues either on the same subunit or on two different subunits shall be described. The position of the disulfide bonds in the SubstanceProtein shall be listed in increasing order of subunit number and position within subunit followed by the abbreviation of the amino acids involved. The disulfide linkage positions shall actually contain the amino acid Cysteine at the respective positions.

numberOfSubunits

IntegerType numberOfSubunits

Number of linear sequences of amino acids linked through peptide bonds. The number of subunits constituting the SubstanceProtein shall be described. It is possible that the number of subunits can be variable.

sequenceType

CodeableConcept sequenceType

The SubstanceProtein descriptive elements will only be used when a complete or partial amino acid sequence is available or derivable from a nucleic acid sequence.

subunit

List<SubstanceProtein.SubstanceProteinSubunitComponent> subunit

This subclause refers to the description of each subunit constituting the SubstanceProtein. A subunit is a linear sequence of amino acids linked through peptide bonds. The Subunit information shall be provided when the finished SubstanceProtein is a complex of multiple sequences; subunits are not used to delineate domains within a single sequence. Subunits are listed in order of decreasing length; sequences of the same length will be ordered by decreasing molecular weight; subunits that have identical sequences will be repeated multiple times.

Class org.hl7.fhir.r4.model.SubstanceProtein.SubstanceProteinSubunitComponent

class SubstanceProteinSubunitComponent extends BackboneElement implements Serializable

serialVersionUID:

99973841L

Serialized Fields

cTerminalModification

StringType cTerminalModification

The modification at the C-terminal shall be specified.

cTerminalModificationId

Identifier cTerminalModificationId

Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID.

length

IntegerType length

Length of linear sequences of amino acids contained in the subunit.

nTerminalModification

StringType nTerminalModification

The name of the fragment modified at the N-terminal of the SubstanceProtein shall be specified.

nTerminalModificationId

Identifier nTerminalModificationId

Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID.

sequence

StringType sequence

The sequence information shall be provided enumerating the amino acids from N- to C-terminal end using standard single-letter amino acid codes. Uppercase shall be used for L-amino acids and lowercase for D-amino acids. Transcribed SubstanceProteins will always be described using the translated sequence; for synthetic peptide containing amino acids that are not represented with a single letter code an X should be used within the sequence. The modified amino acids will be distinguished by their position in the sequence.

sequenceAttachment

Attachment sequenceAttachment

The sequence information shall be provided enumerating the amino acids from N- to C-terminal end using standard single-letter amino acid codes. Uppercase shall be used for L-amino acids and lowercase for D-amino acids. Transcribed SubstanceProteins will always be described using the translated sequence; for synthetic peptide containing amino acids that are not represented with a single letter code an X should be used within the sequence. The modified amino acids will be distinguished by their position in the sequence.

subunit

IntegerType subunit

Index of primary sequences of amino acids linked through peptide bonds in order of decreasing length. Sequences of the same length will be ordered by molecular weight. Subunits that have identical sequences will be repeated and have sequential subscripts.

Class org.hl7.fhir.r4.model.SubstanceReferenceInformation

class SubstanceReferenceInformation extends DomainResource implements Serializable

serialVersionUID:

890303332L

Serialized Fields

classification

List<SubstanceReferenceInformation.SubstanceReferenceInformationClassificationComponent> classification

Todo.

comment

StringType comment

Todo.

gene

List<SubstanceReferenceInformation.SubstanceReferenceInformationGeneComponent> gene

Todo.

geneElement

List<SubstanceReferenceInformation.SubstanceReferenceInformationGeneElementComponent> geneElement

Todo.

target

List<SubstanceReferenceInformation.SubstanceReferenceInformationTargetComponent> target

Todo.

Class org.hl7.fhir.r4.model.SubstanceReferenceInformation.SubstanceReferenceInformationClassificationComponent

class SubstanceReferenceInformationClassificationComponent extends BackboneElement implements Serializable

serialVersionUID:

-430084579L

Serialized Fields

classification

CodeableConcept classification

Todo.

domain

CodeableConcept domain

Todo.

source

List<Reference> source

Todo.

sourceTarget

List<DocumentReference> sourceTarget

The actual objects that are the target of the reference (Todo.)

subtype

List<CodeableConcept> subtype

Todo.

Class org.hl7.fhir.r4.model.SubstanceReferenceInformation.SubstanceReferenceInformationGeneComponent

class SubstanceReferenceInformationGeneComponent extends BackboneElement implements Serializable

serialVersionUID:

1615185105L

Serialized Fields

gene

CodeableConcept gene

Todo.

geneSequenceOrigin

CodeableConcept geneSequenceOrigin

Todo.

source

List<Reference> source

Todo.

sourceTarget

List<DocumentReference> sourceTarget

The actual objects that are the target of the reference (Todo.)

Class org.hl7.fhir.r4.model.SubstanceReferenceInformation.SubstanceReferenceInformationGeneElementComponent

class SubstanceReferenceInformationGeneElementComponent extends BackboneElement implements Serializable

serialVersionUID:

2055145950L

Serialized Fields

element

Identifier element

Todo.

source

List<Reference> source

Todo.

sourceTarget

List<DocumentReference> sourceTarget

The actual objects that are the target of the reference (Todo.)

type

CodeableConcept type

Todo.

Class org.hl7.fhir.r4.model.SubstanceReferenceInformation.SubstanceReferenceInformationTargetComponent

class SubstanceReferenceInformationTargetComponent extends BackboneElement implements Serializable

serialVersionUID:

-1682270197L

Serialized Fields

amount

Type amount

Todo.

amountType

CodeableConcept amountType

Todo.

interaction

CodeableConcept interaction

Todo.

organism

CodeableConcept organism

Todo.

organismType

CodeableConcept organismType

Todo.

source

List<Reference> source

Todo.

sourceTarget

List<DocumentReference> sourceTarget

The actual objects that are the target of the reference (Todo.)

target

Identifier target

Todo.

type

CodeableConcept type

Todo.

Class org.hl7.fhir.r4.model.SubstanceSourceMaterial

class SubstanceSourceMaterial extends DomainResource implements Serializable

serialVersionUID:

442657667L

Serialized Fields

countryOfOrigin

List<CodeableConcept> countryOfOrigin

The country where the plant material is harvested or the countries where the plasma is sourced from as laid down in accordance with the Plasma Master File. For ?Plasma-derived substances? the attribute country of origin provides information about the countries used for the manufacturing of the Cryopoor plama or Crioprecipitate.

developmentStage

CodeableConcept developmentStage

Stage of life for animals, plants, insects and microorganisms. This information shall be provided only when the substance is significantly different in these stages (e.g. foetal bovine serum).

fractionDescription

List<SubstanceSourceMaterial.SubstanceSourceMaterialFractionDescriptionComponent> fractionDescription

Many complex materials are fractions of parts of plants, animals, or minerals. Fraction elements are often necessary to define both Substances and Specified Group 1 Substances. For substances derived from Plants, fraction information will be captured at the Substance information level ( . Oils, Juices and Exudates). Additional information for Extracts, such as extraction solvent composition, will be captured at the Specified Substance Group 1 information level. For plasma-derived products fraction information will be captured at the Substance and the Specified Substance Group 1 levels.

geographicalLocation

List<StringType> geographicalLocation

The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.

organism

SubstanceSourceMaterial.SubstanceSourceMaterialOrganismComponent organism

This subclause describes the organism which the substance is derived from. For vaccines, the parent organism shall be specified based on these subclause elements. As an example, full taxonomy will be described for the Substance Name: ., Leaf.

organismId

Identifier organismId

The unique identifier associated with the source material parent organism shall be specified.

organismName

StringType organismName

The organism accepted Scientific name shall be provided based on the organism taxonomy.

parentSubstanceId

List<Identifier> parentSubstanceId

The parent of the herbal drug Ginkgo biloba, Leaf is the substance ID of the substance (fresh) of Ginkgo biloba L. or Ginkgo biloba L. (Whole plant).

parentSubstanceName

List<StringType> parentSubstanceName

The parent substance of the Herbal Drug, or Herbal preparation.

partDescription

List<SubstanceSourceMaterial.SubstanceSourceMaterialPartDescriptionComponent> partDescription

To do.

sourceMaterialClass

CodeableConcept sourceMaterialClass

General high level classification of the source material specific to the origin of the material.

sourceMaterialState

CodeableConcept sourceMaterialState

The state of the source material when extracted.

sourceMaterialType

CodeableConcept sourceMaterialType

The type of the source material shall be specified based on a controlled vocabulary. For vaccines, this subclause refers to the class of infectious agent.

Class org.hl7.fhir.r4.model.SubstanceSourceMaterial.SubstanceSourceMaterialFractionDescriptionComponent

class SubstanceSourceMaterialFractionDescriptionComponent extends BackboneElement implements Serializable

serialVersionUID:

-1118226733L

Serialized Fields

fraction

StringType fraction

This element is capturing information about the fraction of a plant part, or human plasma for fractionation.

materialType

CodeableConcept materialType

The specific type of the material constituting the component. For Herbal preparations the particulars of the extracts (liquid/dry) is described in Specified Substance Group 1.

Class org.hl7.fhir.r4.model.SubstanceSourceMaterial.SubstanceSourceMaterialOrganismAuthorComponent

class SubstanceSourceMaterialOrganismAuthorComponent extends BackboneElement implements Serializable

serialVersionUID:

1429770120L

Serialized Fields

authorDescription

StringType authorDescription

The author of an organism species shall be specified. The author year of an organism shall also be specified when applicable; refers to the year in which the first author(s) published the infraspecific plant/animal name (of any rank).

authorType

CodeableConcept authorType

The type of author of an organism species shall be specified. The parenthetical author of an organism species refers to the first author who published the plant/animal name (of any rank). The primary author of an organism species refers to the first author(s), who validly published the plant/animal name.

Class org.hl7.fhir.r4.model.SubstanceSourceMaterial.SubstanceSourceMaterialOrganismComponent

class SubstanceSourceMaterialOrganismComponent extends BackboneElement implements Serializable

serialVersionUID:

941648312L

Serialized Fields

author

List<SubstanceSourceMaterial.SubstanceSourceMaterialOrganismAuthorComponent> author

4.9.13.6.1 Author type (Conditional).

family

CodeableConcept family

The family of an organism shall be specified.

genus

CodeableConcept genus

The genus of an organism shall be specified; refers to the Latin epithet of the genus element of the plant/animal scientific name; it is present in names for genera, species and infraspecies.

hybrid

SubstanceSourceMaterial.SubstanceSourceMaterialOrganismHybridComponent hybrid

4.9.13.8.1 Hybrid species maternal organism ID (Optional).

intraspecificDescription

StringType intraspecificDescription

The intraspecific description of an organism shall be specified based on a controlled vocabulary. For Influenza Vaccine, the intraspecific description shall contain the syntax of the antigen in line with the WHO convention.

intraspecificType

CodeableConcept intraspecificType

The Intraspecific type of an organism shall be specified.

organismGeneral

SubstanceSourceMaterial.SubstanceSourceMaterialOrganismOrganismGeneralComponent organismGeneral

4.9.13.7.1 Kingdom (Conditional).

species

CodeableConcept species

The species of an organism shall be specified; refers to the Latin epithet of the species of the plant/animal; it is present in names for species and infraspecies.

Class org.hl7.fhir.r4.model.SubstanceSourceMaterial.SubstanceSourceMaterialOrganismHybridComponent

class SubstanceSourceMaterialOrganismHybridComponent extends BackboneElement implements Serializable

serialVersionUID:

1981189787L

Serialized Fields

hybridType

CodeableConcept hybridType

The hybrid type of an organism shall be specified.

maternalOrganismId

StringType maternalOrganismId

The identifier of the maternal species constituting the hybrid organism shall be specified based on a controlled vocabulary. For plants, the parents aren?t always known, and it is unlikely that it will be known which is maternal and which is paternal.

maternalOrganismName

StringType maternalOrganismName

The name of the maternal species constituting the hybrid organism shall be specified. For plants, the parents aren?t always known, and it is unlikely that it will be known which is maternal and which is paternal.

paternalOrganismId

StringType paternalOrganismId

The identifier of the paternal species constituting the hybrid organism shall be specified based on a controlled vocabulary.

paternalOrganismName

StringType paternalOrganismName

The name of the paternal species constituting the hybrid organism shall be specified.

Class org.hl7.fhir.r4.model.SubstanceSourceMaterial.SubstanceSourceMaterialOrganismOrganismGeneralComponent

class SubstanceSourceMaterialOrganismOrganismGeneralComponent extends BackboneElement implements Serializable

serialVersionUID:

659838613L

Serialized Fields

class_

CodeableConcept class_

The class of an organism shall be specified.

kingdom

CodeableConcept kingdom

The kingdom of an organism shall be specified.

order

CodeableConcept order

The order of an organism shall be specified,.

phylum

CodeableConcept phylum

The phylum of an organism shall be specified.

Class org.hl7.fhir.r4.model.SubstanceSourceMaterial.SubstanceSourceMaterialPartDescriptionComponent

class SubstanceSourceMaterialPartDescriptionComponent extends BackboneElement implements Serializable

serialVersionUID:

308875915L

Serialized Fields

part

CodeableConcept part

Entity of anatomical origin of source material within an organism.

partLocation

CodeableConcept partLocation

The detailed anatomic location when the part can be extracted from different anatomical locations of the organism. Multiple alternative locations may apply.

Class org.hl7.fhir.r4.model.SubstanceSpecification

class SubstanceSpecification extends DomainResource implements Serializable

serialVersionUID:

1782072718L

Serialized Fields

code

List<SubstanceSpecification.SubstanceSpecificationCodeComponent> code

Codes associated with the substance.

comment

StringType comment

Textual comment about this record of a substance.

description

StringType description

Textual description of the substance.

domain

CodeableConcept domain

If the substance applies to only human or veterinary use.

identifier

Identifier identifier

Identifier by which this substance is known.

moiety

List<SubstanceSpecification.SubstanceSpecificationMoietyComponent> moiety

Moiety, for structural modifications.

molecularWeight

List<SubstanceSpecification.SubstanceSpecificationStructureIsotopeMolecularWeightComponent> molecularWeight

The molecular weight or weight range (for proteins, polymers or nucleic acids).

name

List<SubstanceSpecification.SubstanceSpecificationNameComponent> name

Names applicable to this substance.

nucleicAcid

Reference nucleicAcid

Data items specific to nucleic acids.

nucleicAcidTarget

SubstanceNucleicAcid nucleicAcidTarget

The actual object that is the target of the reference (Data items specific to nucleic acids.)

polymer

Reference polymer

Data items specific to polymers.

polymerTarget

SubstancePolymer polymerTarget

The actual object that is the target of the reference (Data items specific to polymers.)

property

List<SubstanceSpecification.SubstanceSpecificationPropertyComponent> property

General specifications for this substance, including how it is related to other substances.

protein

Reference protein

Data items specific to proteins.

proteinTarget

SubstanceProtein proteinTarget

The actual object that is the target of the reference (Data items specific to proteins.)

referenceInformation

Reference referenceInformation

General information detailing this substance.

referenceInformationTarget

SubstanceReferenceInformation referenceInformationTarget

The actual object that is the target of the reference (General information detailing this substance.)

relationship

List<SubstanceSpecification.SubstanceSpecificationRelationshipComponent> relationship

A link between this substance and another, with details of the relationship.

source

List<Reference> source

Supporting literature.

sourceMaterial

Reference sourceMaterial

Material or taxonomic/anatomical source for the substance.

sourceMaterialTarget

SubstanceSourceMaterial sourceMaterialTarget

The actual object that is the target of the reference (Material or taxonomic/anatomical source for the substance.)

sourceTarget

List<DocumentReference> sourceTarget

The actual objects that are the target of the reference (Supporting literature.)

status

CodeableConcept status

Status of substance within the catalogue e.g. approved.

structure

SubstanceSpecification.SubstanceSpecificationStructureComponent structure

Structural information.

type

CodeableConcept type

High level categorization, e.g. polymer or nucleic acid.

Class org.hl7.fhir.r4.model.SubstanceSpecification.SubstanceSpecificationCodeComponent

class SubstanceSpecificationCodeComponent extends BackboneElement implements Serializable

serialVersionUID:

-1629693460L

Serialized Fields

code

CodeableConcept code

The specific code.

comment

StringType comment

Any comment can be provided in this field, if necessary.

source

List<Reference> source

Supporting literature.

sourceTarget

List<DocumentReference> sourceTarget

The actual objects that are the target of the reference (Supporting literature.)

status

CodeableConcept status

Status of the code assignment.

statusDate

DateTimeType statusDate

The date at which the code status is changed as part of the terminology maintenance.

Class org.hl7.fhir.r4.model.SubstanceSpecification.SubstanceSpecificationMoietyComponent

class SubstanceSpecificationMoietyComponent extends BackboneElement implements Serializable

serialVersionUID:

-505630417L

Serialized Fields

amount

Type amount

Quantitative value for this moiety.

identifier

Identifier identifier

Identifier by which this moiety substance is known.

molecularFormula

StringType molecularFormula

Molecular formula.

name

StringType name

Textual name for this moiety substance.

opticalActivity

CodeableConcept opticalActivity

Optical activity type.

role

CodeableConcept role

Role that the moiety is playing.

stereochemistry

CodeableConcept stereochemistry

Stereochemistry type.

Class org.hl7.fhir.r4.model.SubstanceSpecification.SubstanceSpecificationNameComponent

class SubstanceSpecificationNameComponent extends BackboneElement implements Serializable

serialVersionUID:

1547107852L

Serialized Fields

domain

List<CodeableConcept> domain

The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive.

jurisdiction

List<CodeableConcept> jurisdiction

The jurisdiction where this name applies.

language

List<CodeableConcept> language

Language of the name.

name

StringType name

The actual name.

official

List<SubstanceSpecification.SubstanceSpecificationNameOfficialComponent> official

Details of the official nature of this name.

preferred

BooleanType preferred

If this is the preferred name for this substance.

source

List<Reference> source

Supporting literature.

sourceTarget

List<DocumentReference> sourceTarget

The actual objects that are the target of the reference (Supporting literature.)

status

CodeableConcept status

The status of the name.

synonym

List<SubstanceSpecification.SubstanceSpecificationNameComponent> synonym

A synonym of this name.

translation

List<SubstanceSpecification.SubstanceSpecificationNameComponent> translation

A translation for this name.

type

CodeableConcept type

Name type.

Class org.hl7.fhir.r4.model.SubstanceSpecification.SubstanceSpecificationNameOfficialComponent

class SubstanceSpecificationNameOfficialComponent extends BackboneElement implements Serializable

serialVersionUID:

-2040011008L

Serialized Fields

authority

CodeableConcept authority

Which authority uses this official name.

date

DateTimeType date

Date of official name change.

status

CodeableConcept status

The status of the official name.

Class org.hl7.fhir.r4.model.SubstanceSpecification.SubstanceSpecificationPropertyComponent

class SubstanceSpecificationPropertyComponent extends BackboneElement implements Serializable

serialVersionUID:

556834916L

Serialized Fields

amount

Type amount

Quantitative value for this property.

category

CodeableConcept category

A category for this property, e.g. Physical, Chemical, Enzymatic.

code

CodeableConcept code

Property type e.g. viscosity, pH, isoelectric point.

definingSubstance

Type definingSubstance

A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol).

parameters

StringType parameters

Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1).

Class org.hl7.fhir.r4.model.SubstanceSpecification.SubstanceSpecificationRelationshipComponent

class SubstanceSpecificationRelationshipComponent extends BackboneElement implements Serializable

serialVersionUID:

-1277419269L

Serialized Fields

amount

Type amount

A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.

amountRatioLowLimit

Ratio amountRatioLowLimit

For use when the numeric.

amountType

CodeableConcept amountType

An operator for the amount, for example "average", "approximately", "less than".

isDefining

BooleanType isDefining

For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships.

relationship

CodeableConcept relationship

For example "salt to parent", "active moiety", "starting material".

source

List<Reference> source

Supporting literature.

sourceTarget

List<DocumentReference> sourceTarget

The actual objects that are the target of the reference (Supporting literature.)

substance

Type substance

A pointer to another substance, as a resource or just a representational code.

Class org.hl7.fhir.r4.model.SubstanceSpecification.SubstanceSpecificationStructureComponent

class SubstanceSpecificationStructureComponent extends BackboneElement implements Serializable

serialVersionUID:

-851521497L

Serialized Fields

isotope

List<SubstanceSpecification.SubstanceSpecificationStructureIsotopeComponent> isotope

Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio.

molecularFormula

StringType molecularFormula

Molecular formula.

molecularFormulaByMoiety

StringType molecularFormulaByMoiety

Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot.

molecularWeight

SubstanceSpecification.SubstanceSpecificationStructureIsotopeMolecularWeightComponent molecularWeight

The molecular weight or weight range (for proteins, polymers or nucleic acids).

opticalActivity

CodeableConcept opticalActivity

Optical activity type.

representation

List<SubstanceSpecification.SubstanceSpecificationStructureRepresentationComponent> representation

Molecular structural representation.

source

List<Reference> source

Supporting literature.

sourceTarget

List<DocumentReference> sourceTarget

The actual objects that are the target of the reference (Supporting literature.)

stereochemistry

CodeableConcept stereochemistry

Stereochemistry type.

Class org.hl7.fhir.r4.model.SubstanceSpecification.SubstanceSpecificationStructureIsotopeComponent

class SubstanceSpecificationStructureIsotopeComponent extends BackboneElement implements Serializable

serialVersionUID:

-531167114L

Serialized Fields

halfLife

Quantity halfLife

Half life - for a non-natural nuclide.

identifier

Identifier identifier

Substance identifier for each non-natural or radioisotope.

molecularWeight

SubstanceSpecification.SubstanceSpecificationStructureIsotopeMolecularWeightComponent molecularWeight

The molecular weight or weight range (for proteins, polymers or nucleic acids).

name

CodeableConcept name

Substance name for each non-natural or radioisotope.

substitution

CodeableConcept substitution

The type of isotopic substitution present in a single substance.

Class org.hl7.fhir.r4.model.SubstanceSpecification.SubstanceSpecificationStructureIsotopeMolecularWeightComponent

class SubstanceSpecificationStructureIsotopeMolecularWeightComponent extends BackboneElement implements Serializable

serialVersionUID:

805939780L

Serialized Fields

amount

Quantity amount

Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.

method

CodeableConcept method

The method by which the molecular weight was determined.

type

CodeableConcept type

Type of molecular weight such as exact, average (also known as. number average), weight average.

Class org.hl7.fhir.r4.model.SubstanceSpecification.SubstanceSpecificationStructureRepresentationComponent

class SubstanceSpecificationStructureRepresentationComponent extends BackboneElement implements Serializable

serialVersionUID:

167954495L

Serialized Fields

attachment

Attachment attachment

An attached file with the structural representation.

representation

StringType representation

The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX.

type

CodeableConcept type

The type of structure (e.g. Full, Partial, Representative).

Class org.hl7.fhir.r4.model.SupplyDelivery

class SupplyDelivery extends DomainResource implements Serializable

serialVersionUID:

-750389806L

Serialized Fields

basedOn

List<Reference> basedOn

A plan, proposal or order that is fulfilled in whole or in part by this event.

basedOnTarget

List<SupplyRequest> basedOnTarget

The actual objects that are the target of the reference (A plan, proposal or order that is fulfilled in whole or in part by this event.)

destination

Reference destination

Identification of the facility/location where the Supply was shipped to, as part of the dispense event.

destinationTarget

Location destinationTarget

The actual object that is the target of the reference (Identification of the facility/location where the Supply was shipped to, as part of the dispense event.)

identifier

List<Identifier> identifier

Identifier for the supply delivery event that is used to identify it across multiple disparate systems.

occurrence

Type occurrence

The date or time(s) the activity occurred.

partOf

List<Reference> partOf

A larger event of which this particular event is a component or step.

partOfTarget

List<Resource> partOfTarget

The actual objects that are the target of the reference (A larger event of which this particular event is a component or step.)

patient

Reference patient

A link to a resource representing the person whom the delivered item is for.

patientTarget

Patient patientTarget

The actual object that is the target of the reference (A link to a resource representing the person whom the delivered item is for.)

receiver

List<Reference> receiver

Identifies the person who picked up the Supply.

receiverTarget

List<Resource> receiverTarget

The actual objects that are the target of the reference (Identifies the person who picked up the Supply.)

status

Enumeration<SupplyDelivery.SupplyDeliveryStatus> status

A code specifying the state of the dispense event.

suppliedItem

SupplyDelivery.SupplyDeliverySuppliedItemComponent suppliedItem

The item that is being delivered or has been supplied.

supplier

Reference supplier

The individual responsible for dispensing the medication, supplier or device.

supplierTarget

Resource supplierTarget

The actual object that is the target of the reference (The individual responsible for dispensing the medication, supplier or device.)

type

CodeableConcept type

Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

Class org.hl7.fhir.r4.model.SupplyDelivery.SupplyDeliveryStatusEnumFactory

class SupplyDeliveryStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.SupplyDelivery.SupplyDeliverySuppliedItemComponent

class SupplyDeliverySuppliedItemComponent extends BackboneElement implements Serializable

serialVersionUID:

1628109307L

Serialized Fields

item

Type item

Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.

quantity

Quantity quantity

The amount of supply that has been dispensed. Includes unit of measure.

Class org.hl7.fhir.r4.model.SupplyRequest

class SupplyRequest extends DomainResource implements Serializable

serialVersionUID:

1456312151L

Serialized Fields

authoredOn

DateTimeType authoredOn

When the request was made.

category

CodeableConcept category

Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.

deliverFrom

Reference deliverFrom

Where the supply is expected to come from.

deliverFromTarget

Resource deliverFromTarget

The actual object that is the target of the reference (Where the supply is expected to come from.)

deliverTo

Reference deliverTo

Where the supply is destined to go.

deliverToTarget

Resource deliverToTarget

The actual object that is the target of the reference (Where the supply is destined to go.)

identifier

List<Identifier> identifier

Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.

item

Type item

The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.

occurrence

Type occurrence

When the request should be fulfilled.

parameter

List<SupplyRequest.SupplyRequestParameterComponent> parameter

Specific parameters for the ordered item. For example, the size of the indicated item.

priority

Enumeration<SupplyRequest.RequestPriority> priority

Indicates how quickly this SupplyRequest should be addressed with respect to other requests.

quantity

Quantity quantity

The amount that is being ordered of the indicated item.

reasonCode

List<CodeableConcept> reasonCode

The reason why the supply item was requested.

reasonReference

List<Reference> reasonReference

The reason why the supply item was requested.

reasonReferenceTarget

List<Resource> reasonReferenceTarget

The actual objects that are the target of the reference (The reason why the supply item was requested.)

requester

Reference requester

The device, practitioner, etc. who initiated the request.

requesterTarget

Resource requesterTarget

The actual object that is the target of the reference (The device, practitioner, etc. who initiated the request.)

status

Enumeration<SupplyRequest.SupplyRequestStatus> status

Status of the supply request.

supplier

List<Reference> supplier

Who is intended to fulfill the request.

supplierTarget

List<Resource> supplierTarget

The actual objects that are the target of the reference (Who is intended to fulfill the request.)

Class org.hl7.fhir.r4.model.SupplyRequest.RequestPriorityEnumFactory

class RequestPriorityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.SupplyRequest.SupplyRequestParameterComponent

class SupplyRequestParameterComponent extends BackboneElement implements Serializable

serialVersionUID:

884525025L

Serialized Fields

code

CodeableConcept code

A code or string that identifies the device detail being asserted.

value

Type value

The value of the device detail.

Class org.hl7.fhir.r4.model.SupplyRequest.SupplyRequestStatusEnumFactory

class SupplyRequestStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Task

class Task extends DomainResource implements Serializable

serialVersionUID:

-765029272L

Serialized Fields

authoredOn

DateTimeType authoredOn

The date and time this task was created.

basedOn

List<Reference> basedOn

BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient.

basedOnTarget

List<Resource> basedOnTarget

The actual objects that are the target of the reference (BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient.)

businessStatus

CodeableConcept businessStatus

Contains business-specific nuances of the business state.

code

CodeableConcept code

A name or code (or both) briefly describing what the task involves.

description

StringType description

A free-text description of what is to be performed.

encounter

Reference encounter

The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.)

executionPeriod

Period executionPeriod

Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).

focus

Reference focus

The request being actioned or the resource being manipulated by this task.

focusTarget

Resource focusTarget

The actual object that is the target of the reference (The request being actioned or the resource being manipulated by this task.)

for_

Reference for_

The entity who benefits from the performance of the service specified in the task (e.g., the patient).

for_Target

Resource for_Target

The actual object that is the target of the reference (The entity who benefits from the performance of the service specified in the task (e.g., the patient).)

groupIdentifier

Identifier groupIdentifier

An identifier that links together multiple tasks and other requests that were created in the same context.

identifier

List<Identifier> identifier

The business identifier for this task.

input

List<Task.ParameterComponent> input

Additional information that may be needed in the execution of the task.

instantiatesCanonical

CanonicalType instantiatesCanonical

The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.

instantiatesUri

UriType instantiatesUri

The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.

insurance

List<Reference> insurance

Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.

insuranceTarget

List<Resource> insuranceTarget

The actual objects that are the target of the reference (Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.)

intent

Enumeration<Task.TaskIntent> intent

Indicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.

lastModified

DateTimeType lastModified

The date and time of last modification to this task.

location

Reference location

Principal physical location where the this task is performed.

locationTarget

Location locationTarget

The actual object that is the target of the reference (Principal physical location where the this task is performed.)

note

List<Annotation> note

Free-text information captured about the task as it progresses.

output

List<Task.TaskOutputComponent> output

Outputs produced by the Task.

owner

Reference owner

Individual organization or Device currently responsible for task execution.

ownerTarget

Resource ownerTarget

The actual object that is the target of the reference (Individual organization or Device currently responsible for task execution.)

partOf

List<Reference> partOf

Task that this particular task is part of.

partOfTarget

List<Task> partOfTarget

The actual objects that are the target of the reference (Task that this particular task is part of.)

performerType

List<CodeableConcept> performerType

The kind of participant that should perform the task.

priority

Enumeration<Task.TaskPriority> priority

Indicates how quickly the Task should be addressed with respect to other requests.

reasonCode

CodeableConcept reasonCode

A description or code indicating why this task needs to be performed.

reasonReference

Reference reasonReference

A resource reference indicating why this task needs to be performed.

reasonReferenceTarget

Resource reasonReferenceTarget

The actual object that is the target of the reference (A resource reference indicating why this task needs to be performed.)

relevantHistory

List<Reference> relevantHistory

Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.

relevantHistoryTarget

List<Provenance> relevantHistoryTarget

The actual objects that are the target of the reference (Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.)

requester

Reference requester

The creator of the task.

requesterTarget

Resource requesterTarget

The actual object that is the target of the reference (The creator of the task.)

restriction

Task.TaskRestrictionComponent restriction

If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.

status

Enumeration<Task.TaskStatus> status

The current status of the task.

statusReason

CodeableConcept statusReason

An explanation as to why this task is held, failed, was refused, etc.

Class org.hl7.fhir.r4.model.Task.ParameterComponent

class ParameterComponent extends BackboneElement implements Serializable

serialVersionUID:

-850267045L

Serialized Fields

type

CodeableConcept type

A code or description indicating how the input is intended to be used as part of the task execution.

value

Type value

The value of the input parameter as a basic type.

Class org.hl7.fhir.r4.model.Task.TaskIntentEnumFactory

class TaskIntentEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Task.TaskOutputComponent

class TaskOutputComponent extends BackboneElement implements Serializable

serialVersionUID:

-850267045L

Serialized Fields

type

CodeableConcept type

The name of the Output parameter.

value

Type value

The value of the Output parameter as a basic type.

Class org.hl7.fhir.r4.model.Task.TaskPriorityEnumFactory

class TaskPriorityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Task.TaskRestrictionComponent

class TaskRestrictionComponent extends BackboneElement implements Serializable

serialVersionUID:

1503908360L

Serialized Fields

period

Period period

Over what time-period is fulfillment sought.

recipient

List<Reference> recipient

For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?

recipientTarget

List<Resource> recipientTarget

The actual objects that are the target of the reference (For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?)

repetitions

PositiveIntType repetitions

Indicates the number of times the requested action should occur.

Class org.hl7.fhir.r4.model.Task.TaskStatusEnumFactory

class TaskStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.TerminologyCapabilities

class TerminologyCapabilities extends MetadataResource implements Serializable

serialVersionUID:

-1899106119L

Serialized Fields

closure

TerminologyCapabilities.TerminologyCapabilitiesClosureComponent closure

Whether the $closure operation is supported.

codeSearch

Enumeration<TerminologyCapabilities.CodeSearchSupport> codeSearch

The degree to which the server supports the code search parameter on ValueSet, if it is supported.

codeSystem

List<TerminologyCapabilities.TerminologyCapabilitiesCodeSystemComponent> codeSystem

Identifies a code system that is supported by the server. If there is a no code system URL, then this declares the general assumptions a client can make about support for any CodeSystem resource.

copyright

MarkdownType copyright

A copyright statement relating to the terminology capabilities and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the terminology capabilities.

expansion

TerminologyCapabilities.TerminologyCapabilitiesExpansionComponent expansion

Information about the [ValueSet/$expand](valueset-operation-expand.html) operation.

implementation

TerminologyCapabilities.TerminologyCapabilitiesImplementationComponent implementation

Identifies a specific implementation instance that is described by the terminology capability statement - i.e. a particular installation, rather than the capabilities of a software program.

kind

Enumeration<TerminologyCapabilities.CapabilityStatementKind> kind

The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).

lockedDate

BooleanType lockedDate

Whether the server supports lockedDate.

purpose

MarkdownType purpose

Explanation of why this terminology capabilities is needed and why it has been designed as it has.

software

TerminologyCapabilities.TerminologyCapabilitiesSoftwareComponent software

Software that is covered by this terminology capability statement. It is used when the statement describes the capabilities of a particular software version, independent of an installation.

translation

TerminologyCapabilities.TerminologyCapabilitiesTranslationComponent translation

Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation.

validateCode

TerminologyCapabilities.TerminologyCapabilitiesValidateCodeComponent validateCode

Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation.

Class org.hl7.fhir.r4.model.TerminologyCapabilities.CapabilityStatementKindEnumFactory

class CapabilityStatementKindEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.TerminologyCapabilities.CodeSearchSupportEnumFactory

class CodeSearchSupportEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.TerminologyCapabilities.TerminologyCapabilitiesClosureComponent

class TerminologyCapabilitiesClosureComponent extends BackboneElement implements Serializable

serialVersionUID:

1900484343L

Serialized Fields

translation

BooleanType translation

If cross-system closure is supported.

Class org.hl7.fhir.r4.model.TerminologyCapabilities.TerminologyCapabilitiesCodeSystemComponent

class TerminologyCapabilitiesCodeSystemComponent extends BackboneElement implements Serializable

serialVersionUID:

-1593622817L

Serialized Fields

subsumption

BooleanType subsumption

True if subsumption is supported for this version of the code system.

uri

CanonicalType uri

URI for the Code System.

version

List<TerminologyCapabilities.TerminologyCapabilitiesCodeSystemVersionComponent> version

For the code system, a list of versions that are supported by the server.

Class org.hl7.fhir.r4.model.TerminologyCapabilities.TerminologyCapabilitiesCodeSystemVersionComponent

class TerminologyCapabilitiesCodeSystemVersionComponent extends BackboneElement implements Serializable

serialVersionUID:

1857571343L

Serialized Fields

code

StringType code

For version-less code systems, there should be a single version with no identifier.

compositional

BooleanType compositional

If the compositional grammar defined by the code system is supported.

filter

List<TerminologyCapabilities.TerminologyCapabilitiesCodeSystemVersionFilterComponent> filter

Filter Properties supported.

isDefault

BooleanType isDefault

If this is the default version for this code system.

language

List<CodeType> language

Language Displays supported.

property

List<CodeType> property

Properties supported for $lookup.

Class org.hl7.fhir.r4.model.TerminologyCapabilities.TerminologyCapabilitiesCodeSystemVersionFilterComponent

class TerminologyCapabilitiesCodeSystemVersionFilterComponent extends BackboneElement implements Serializable

serialVersionUID:

-489160282L

Serialized Fields

code

CodeType code

Code of the property supported.

op

List<CodeType> op

Operations supported for the property.

Class org.hl7.fhir.r4.model.TerminologyCapabilities.TerminologyCapabilitiesExpansionComponent

class TerminologyCapabilitiesExpansionComponent extends BackboneElement implements Serializable

serialVersionUID:

-1011350616L

Serialized Fields

hierarchical

BooleanType hierarchical

Whether the server can return nested value sets.

incomplete

BooleanType incomplete

Allow request for incomplete expansions?

paging

BooleanType paging

Whether the server supports paging on expansion.

parameter

List<TerminologyCapabilities.TerminologyCapabilitiesExpansionParameterComponent> parameter

Supported expansion parameter.

textFilter

MarkdownType textFilter

Documentation about text searching works.

Class org.hl7.fhir.r4.model.TerminologyCapabilities.TerminologyCapabilitiesExpansionParameterComponent

class TerminologyCapabilitiesExpansionParameterComponent extends BackboneElement implements Serializable

serialVersionUID:

-1703372741L

Serialized Fields

documentation

StringType documentation

Description of support for parameter.

name

CodeType name

Expansion Parameter name.

Class org.hl7.fhir.r4.model.TerminologyCapabilities.TerminologyCapabilitiesImplementationComponent

class TerminologyCapabilitiesImplementationComponent extends BackboneElement implements Serializable

serialVersionUID:

98009649L

Serialized Fields

description

StringType description

Information about the specific installation that this terminology capability statement relates to.

url

UrlType url

An absolute base URL for the implementation.

Class org.hl7.fhir.r4.model.TerminologyCapabilities.TerminologyCapabilitiesSoftwareComponent

class TerminologyCapabilitiesSoftwareComponent extends BackboneElement implements Serializable

serialVersionUID:

-790299911L

Serialized Fields

name

StringType name

Name the software is known by.

version

StringType version

The version identifier for the software covered by this statement.

Class org.hl7.fhir.r4.model.TerminologyCapabilities.TerminologyCapabilitiesTranslationComponent

class TerminologyCapabilitiesTranslationComponent extends BackboneElement implements Serializable

serialVersionUID:

-1727843575L

Serialized Fields

needsMap

BooleanType needsMap

Whether the client must identify the map.

Class org.hl7.fhir.r4.model.TerminologyCapabilities.TerminologyCapabilitiesValidateCodeComponent

class TerminologyCapabilitiesValidateCodeComponent extends BackboneElement implements Serializable

serialVersionUID:

-1212814906L

Serialized Fields

translations

BooleanType translations

Whether translations are validated.

Class org.hl7.fhir.r4.model.TestReport

class TestReport extends DomainResource implements Serializable

serialVersionUID:

79474516L

Serialized Fields

identifier

Identifier identifier

Identifier for the TestScript assigned for external purposes outside the context of FHIR.

issued

DateTimeType issued

When the TestScript was executed and this TestReport was generated.

name

StringType name

A free text natural language name identifying the executed TestScript.

participant

List<TestReport.TestReportParticipantComponent> participant

A participant in the test execution, either the execution engine, a client, or a server.

result

Enumeration<TestReport.TestReportResult> result

The overall result from the execution of the TestScript.

score

DecimalType score

The final score (percentage of tests passed) resulting from the execution of the TestScript.

setup

TestReport.TestReportSetupComponent setup

The results of the series of required setup operations before the tests were executed.

status

Enumeration<TestReport.TestReportStatus> status

The current state of this test report.

teardown

TestReport.TestReportTeardownComponent teardown

The results of the series of operations required to clean up after all the tests were executed (successfully or otherwise).

test

List<TestReport.TestReportTestComponent> test

A test executed from the test script.

tester

StringType tester

Name of the tester producing this report (Organization or individual).

testScript

Reference testScript

Ideally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the `TestScript.url`.

testScriptTarget

TestScript testScriptTarget

The actual object that is the target of the reference (Ideally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the `TestScript.url`.)

Class org.hl7.fhir.r4.model.TestReport.SetupActionAssertComponent

class SetupActionAssertComponent extends BackboneElement implements Serializable

serialVersionUID:

467968193L

Serialized Fields

detail

StringType detail

A link to further details on the result.

message

MarkdownType message

An explanatory message associated with the result.

result

Enumeration<TestReport.TestReportActionResult> result

The result of this assertion.

Class org.hl7.fhir.r4.model.TestReport.SetupActionComponent

class SetupActionComponent extends BackboneElement implements Serializable

serialVersionUID:

-252088305L

Serialized Fields

assert_

TestReport.SetupActionAssertComponent assert_

The results of the assertion performed on the previous operations.

operation

TestReport.SetupActionOperationComponent operation

The operation performed.

Class org.hl7.fhir.r4.model.TestReport.SetupActionOperationComponent

class SetupActionOperationComponent extends BackboneElement implements Serializable

serialVersionUID:

269088798L

Serialized Fields

detail

UriType detail

A link to further details on the result.

message

MarkdownType message

An explanatory message associated with the result.

result

Enumeration<TestReport.TestReportActionResult> result

The result of this operation.

Class org.hl7.fhir.r4.model.TestReport.TeardownActionComponent

class TeardownActionComponent extends BackboneElement implements Serializable

serialVersionUID:

-1099598054L

Serialized Fields

operation

TestReport.SetupActionOperationComponent operation

An operation would involve a REST request to a server.

Class org.hl7.fhir.r4.model.TestReport.TestActionComponent

class TestActionComponent extends BackboneElement implements Serializable

serialVersionUID:

-252088305L

Serialized Fields

assert_

TestReport.SetupActionAssertComponent assert_

The results of the assertion performed on the previous operations.

operation

TestReport.SetupActionOperationComponent operation

An operation would involve a REST request to a server.

Class org.hl7.fhir.r4.model.TestReport.TestReportActionResultEnumFactory

class TestReportActionResultEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.TestReport.TestReportParticipantComponent

class TestReportParticipantComponent extends BackboneElement implements Serializable

serialVersionUID:

577488357L

Serialized Fields

display

StringType display

The display name of the participant.

type

Enumeration<TestReport.TestReportParticipantType> type

The type of participant.

uri

UriType uri

The uri of the participant. An absolute URL is preferred.

Class org.hl7.fhir.r4.model.TestReport.TestReportParticipantTypeEnumFactory

class TestReportParticipantTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.TestReport.TestReportResultEnumFactory

class TestReportResultEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.TestReport.TestReportSetupComponent

class TestReportSetupComponent extends BackboneElement implements Serializable

serialVersionUID:

-123374486L

Serialized Fields

action

List<TestReport.SetupActionComponent> action

Action would contain either an operation or an assertion.

Class org.hl7.fhir.r4.model.TestReport.TestReportStatusEnumFactory

class TestReportStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.TestReport.TestReportTeardownComponent

class TestReportTeardownComponent extends BackboneElement implements Serializable

serialVersionUID:

1168638089L

Serialized Fields

action

List<TestReport.TeardownActionComponent> action

The teardown action will only contain an operation.

Class org.hl7.fhir.r4.model.TestReport.TestReportTestComponent

class TestReportTestComponent extends BackboneElement implements Serializable

serialVersionUID:

-865006110L

Serialized Fields

action

List<TestReport.TestActionComponent> action

Action would contain either an operation or an assertion.

description

StringType description

A short description of the test used by test engines for tracking and reporting purposes.

name

StringType name

The name of this test used for tracking/logging purposes by test engines.

Class org.hl7.fhir.r4.model.TestScript

class TestScript extends MetadataResource implements Serializable

serialVersionUID:

-1433230137L

Serialized Fields

copyright

MarkdownType copyright

A copyright statement relating to the test script and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the test script.

destination

List<TestScript.TestScriptDestinationComponent> destination

An abstract server used in operations within this test script in the destination element.

fixture

List<TestScript.TestScriptFixtureComponent> fixture

Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.

identifier

Identifier identifier

A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance.

metadata

TestScript.TestScriptMetadataComponent metadata

The required capability must exist and are assumed to function correctly on the FHIR server being tested.

origin

List<TestScript.TestScriptOriginComponent> origin

An abstract server used in operations within this test script in the origin element.

profile

List<Reference> profile

Reference to the profile to be used for validation.

profileTarget

List<Resource> profileTarget

The actual objects that are the target of the reference (Reference to the profile to be used for validation.)

purpose

MarkdownType purpose

Explanation of why this test script is needed and why it has been designed as it has.

setup

TestScript.TestScriptSetupComponent setup

A series of required setup operations before tests are executed.

teardown

TestScript.TestScriptTeardownComponent teardown

A series of operations required to clean up after all the tests are executed (successfully or otherwise).

test

List<TestScript.TestScriptTestComponent> test

A test in this script.

variable

List<TestScript.TestScriptVariableComponent> variable

Variable is set based either on element value in response body or on header field value in the response headers.

Class org.hl7.fhir.r4.model.TestScript.AssertionDirectionTypeEnumFactory

class AssertionDirectionTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.TestScript.AssertionOperatorTypeEnumFactory

class AssertionOperatorTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.TestScript.AssertionResponseTypesEnumFactory

class AssertionResponseTypesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.TestScript.SetupActionAssertComponent

class SetupActionAssertComponent extends BackboneElement implements Serializable

serialVersionUID:

-1086518778L

Serialized Fields

compareToSourceExpression

StringType compareToSourceExpression

The FHIRPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.

compareToSourceId

StringType compareToSourceId

Id of the source fixture used as the contents to be evaluated by either the "source/expression" or "sourceId/path" definition.

compareToSourcePath

StringType compareToSourcePath

XPath or JSONPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.

contentType

CodeType contentType

The mime-type contents to compare against the request or response message 'Content-Type' header.

description

StringType description

The description would be used by test engines for tracking and reporting purposes.

direction

Enumeration<TestScript.AssertionDirectionType> direction

The direction to use for the assertion.

expression

StringType expression

The FHIRPath expression to be evaluated against the request or response message contents - HTTP headers and payload.

headerField

StringType headerField

The HTTP header field name e.g. 'Location'.

label

StringType label

The label would be used for tracking/logging purposes by test engines.

minimumId

StringType minimumId

The ID of a fixture. Asserts that the response contains at a minimum the fixture specified by minimumId.

navigationLinks

BooleanType navigationLinks

Whether or not the test execution performs validation on the bundle navigation links.

operator

Enumeration<TestScript.AssertionOperatorType> operator

The operator type defines the conditional behavior of the assert. If not defined, the default is equals.

path

StringType path

The XPath or JSONPath expression to be evaluated against the fixture representing the response received from server.

requestMethod

Enumeration<TestScript.TestScriptRequestMethodCode> requestMethod

The request method or HTTP operation code to compare against that used by the client system under test.

requestURL

StringType requestURL

The value to use in a comparison against the request URL path string.

resource

CodeType resource

The type of the resource. See http://build.fhir.org/resourcelist.html.

response

Enumeration<TestScript.AssertionResponseTypes> response

okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable.

responseCode

StringType responseCode

The value of the HTTP response code to be tested.

sourceId

IdType sourceId

Fixture to evaluate the XPath/JSONPath expression or the headerField against.

validateProfileId

IdType validateProfileId

The ID of the Profile to validate against.

value

StringType value

The value to compare to.

warningOnly

BooleanType warningOnly

Whether or not the test execution will produce a warning only on error for this assert.

Class org.hl7.fhir.r4.model.TestScript.SetupActionComponent

class SetupActionComponent extends BackboneElement implements Serializable

serialVersionUID:

-252088305L

Serialized Fields

assert_

TestScript.SetupActionAssertComponent assert_

Evaluates the results of previous operations to determine if the server under test behaves appropriately.

operation

TestScript.SetupActionOperationComponent operation

The operation to perform.

Class org.hl7.fhir.r4.model.TestScript.SetupActionOperationComponent

class SetupActionOperationComponent extends BackboneElement implements Serializable

serialVersionUID:

300050202L

Serialized Fields

accept

CodeType accept

The mime-type to use for RESTful operation in the 'Accept' header.

contentType

CodeType contentType

The mime-type to use for RESTful operation in the 'Content-Type' header.

description

StringType description

The description would be used by test engines for tracking and reporting purposes.

destination

IntegerType destination

The server where the request message is destined for. Must be one of the server numbers listed in TestScript.destination section.

encodeRequestUrl

BooleanType encodeRequestUrl

Whether or not to implicitly send the request url in encoded format. The default is true to match the standard RESTful client behavior. Set to false when communicating with a server that does not support encoded url paths.

label

StringType label

The label would be used for tracking/logging purposes by test engines.

method

Enumeration<TestScript.TestScriptRequestMethodCode> method

The HTTP method the test engine MUST use for this operation regardless of any other operation details.

origin

IntegerType origin

The server where the request message originates from. Must be one of the server numbers listed in TestScript.origin section.

params

StringType params

Path plus parameters after [type]. Used to set parts of the request URL explicitly.

requestHeader

List<TestScript.SetupActionOperationRequestHeaderComponent> requestHeader

Header elements would be used to set HTTP headers.

requestId

IdType requestId

The fixture id (maybe new) to map to the request.

resource

CodeType resource

The type of the resource. See http://build.fhir.org/resourcelist.html.

responseId

IdType responseId

The fixture id (maybe new) to map to the response.

sourceId

IdType sourceId

The id of the fixture used as the body of a PUT or POST request.

targetId

IdType targetId

Id of fixture used for extracting the [id], [type], and [vid] for GET requests.

type

Coding type

Server interaction or operation type.

url

StringType url

Complete request URL.

Class org.hl7.fhir.r4.model.TestScript.SetupActionOperationRequestHeaderComponent

class SetupActionOperationRequestHeaderComponent extends BackboneElement implements Serializable

serialVersionUID:

274395337L

Serialized Fields

field

StringType field

The HTTP header field e.g. "Accept".

value

StringType value

The value of the header e.g. "application/fhir+xml".

Class org.hl7.fhir.r4.model.TestScript.TeardownActionComponent

class TeardownActionComponent extends BackboneElement implements Serializable

serialVersionUID:

-1099598054L

Serialized Fields

operation

TestScript.SetupActionOperationComponent operation

An operation would involve a REST request to a server.

Class org.hl7.fhir.r4.model.TestScript.TestActionComponent

class TestActionComponent extends BackboneElement implements Serializable

serialVersionUID:

-252088305L

Serialized Fields

assert_

TestScript.SetupActionAssertComponent assert_

Evaluates the results of previous operations to determine if the server under test behaves appropriately.

operation

TestScript.SetupActionOperationComponent operation

An operation would involve a REST request to a server.

Class org.hl7.fhir.r4.model.TestScript.TestScriptDestinationComponent

class TestScriptDestinationComponent extends BackboneElement implements Serializable

serialVersionUID:

-1239935149L

Serialized Fields

index

IntegerType index

Abstract name given to a destination server in this test script. The name is provided as a number starting at 1.

profile

Coding profile

The type of destination profile the test system supports.

Class org.hl7.fhir.r4.model.TestScript.TestScriptFixtureComponent

class TestScriptFixtureComponent extends BackboneElement implements Serializable

serialVersionUID:

1110683307L

Serialized Fields

autocreate

BooleanType autocreate

Whether or not to implicitly create the fixture during setup. If true, the fixture is automatically created on each server being tested during setup, therefore no create operation is required for this fixture in the TestScript.setup section.

autodelete

BooleanType autodelete

Whether or not to implicitly delete the fixture during teardown. If true, the fixture is automatically deleted on each server being tested during teardown, therefore no delete operation is required for this fixture in the TestScript.teardown section.

resource

Reference resource

Reference to the resource (containing the contents of the resource needed for operations).

resourceTarget

Resource resourceTarget

The actual object that is the target of the reference (Reference to the resource (containing the contents of the resource needed for operations).)

Class org.hl7.fhir.r4.model.TestScript.TestScriptMetadataCapabilityComponent

class TestScriptMetadataCapabilityComponent extends BackboneElement implements Serializable

serialVersionUID:

-1368199288L

Serialized Fields

capabilities

CanonicalType capabilities

Minimum capabilities required of server for test script to execute successfully. If server does not meet at a minimum the referenced capability statement, then all tests in this script are skipped.

description

StringType description

Description of the capabilities that this test script is requiring the server to support.

destination

IntegerType destination

Which server these requirements apply to.

link

List<UriType> link

Links to the FHIR specification that describes this interaction and the resources involved in more detail.

origin

List<IntegerType> origin

Which origin server these requirements apply to.

required

BooleanType required

Whether or not the test execution will require the given capabilities of the server in order for this test script to execute.

validated

BooleanType validated

Whether or not the test execution will validate the given capabilities of the server in order for this test script to execute.

Class org.hl7.fhir.r4.model.TestScript.TestScriptMetadataComponent

class TestScriptMetadataComponent extends BackboneElement implements Serializable

serialVersionUID:

745183328L

Serialized Fields

capability

List<TestScript.TestScriptMetadataCapabilityComponent> capability

Capabilities that must exist and are assumed to function correctly on the FHIR server being tested.

link

List<TestScript.TestScriptMetadataLinkComponent> link

A link to the FHIR specification that this test is covering.

Class org.hl7.fhir.r4.model.TestScript.TestScriptMetadataLinkComponent

class TestScriptMetadataLinkComponent extends BackboneElement implements Serializable

serialVersionUID:

213372298L

Serialized Fields

description

StringType description

Short description of the link.

url

UriType url

URL to a particular requirement or feature within the FHIR specification.

Class org.hl7.fhir.r4.model.TestScript.TestScriptOriginComponent

class TestScriptOriginComponent extends BackboneElement implements Serializable

serialVersionUID:

-1239935149L

Serialized Fields

index

IntegerType index

Abstract name given to an origin server in this test script. The name is provided as a number starting at 1.

profile

Coding profile

The type of origin profile the test system supports.

Class org.hl7.fhir.r4.model.TestScript.TestScriptRequestMethodCodeEnumFactory

class TestScriptRequestMethodCodeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.TestScript.TestScriptSetupComponent

class TestScriptSetupComponent extends BackboneElement implements Serializable

serialVersionUID:

-123374486L

Serialized Fields

action

List<TestScript.SetupActionComponent> action

Action would contain either an operation or an assertion.

Class org.hl7.fhir.r4.model.TestScript.TestScriptTeardownComponent

class TestScriptTeardownComponent extends BackboneElement implements Serializable

serialVersionUID:

1168638089L

Serialized Fields

action

List<TestScript.TeardownActionComponent> action

The teardown action will only contain an operation.

Class org.hl7.fhir.r4.model.TestScript.TestScriptTestComponent

class TestScriptTestComponent extends BackboneElement implements Serializable

serialVersionUID:

-865006110L

Serialized Fields

action

List<TestScript.TestActionComponent> action

Action would contain either an operation or an assertion.

description

StringType description

A short description of the test used by test engines for tracking and reporting purposes.

name

StringType name

The name of this test used for tracking/logging purposes by test engines.

Class org.hl7.fhir.r4.model.TestScript.TestScriptVariableComponent

class TestScriptVariableComponent extends BackboneElement implements Serializable

serialVersionUID:

-1592325432L

Serialized Fields

defaultValue

StringType defaultValue

A default, hard-coded, or user-defined value for this variable.

description

StringType description

A free text natural language description of the variable and its purpose.

expression

StringType expression

The FHIRPath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.

headerField

StringType headerField

Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.

hint

StringType hint

Displayable text string with hint help information to the user when entering a default value.

name

StringType name

Descriptive name for this variable.

path

StringType path

XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.

sourceId

IdType sourceId

Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.

Class org.hl7.fhir.r4.model.TimeType

class TimeType extends PrimitiveType<String> implements Externalizable

serialVersionUID:

3L

Serialization Methods

readExternal

public void readExternal(ObjectInput theIn)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput theOut)
                   throws IOException

Throws:

IOException

Class org.hl7.fhir.r4.model.Timing

class Timing extends BackboneType implements Serializable

serialVersionUID:

791565112L

Serialized Fields

code

CodeableConcept code

A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).

event

List<DateTimeType> event

Identifies specific times when the event occurs.

repeat

Timing.TimingRepeatComponent repeat

A set of rules that describe when the event is scheduled.

Class org.hl7.fhir.r4.model.Timing.DayOfWeekEnumFactory

class DayOfWeekEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Timing.EventTimingEnumFactory

class EventTimingEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Timing.TimingRepeatComponent

class TimingRepeatComponent extends Element implements Serializable

serialVersionUID:

-900253756L

Serialized Fields

bounds

Type bounds

Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.

count

PositiveIntType count

A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.

countMax

PositiveIntType countMax

If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.

dayOfWeek

List<Enumeration<Timing.DayOfWeek>> dayOfWeek

If one or more days of week is provided, then the action happens only on the specified day(s).

duration

DecimalType duration

How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.

durationMax

DecimalType durationMax

If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.

durationUnit

Enumeration<Timing.UnitsOfTime> durationUnit

The units of time for the duration, in UCUM units.

frequency

PositiveIntType frequency

The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.

frequencyMax

PositiveIntType frequencyMax

If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.

offset

UnsignedIntType offset

The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.

period

DecimalType period

Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.

periodMax

DecimalType periodMax

If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.

periodUnit

Enumeration<Timing.UnitsOfTime> periodUnit

The units of time for the period in UCUM units.

timeOfDay

List<TimeType> timeOfDay

Specified time of day for action to take place.

when

List<Enumeration<Timing.EventTiming>> when

An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.

Class org.hl7.fhir.r4.model.Timing.UnitsOfTimeEnumFactory

class UnitsOfTimeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.TriggerDefinition

class TriggerDefinition extends Type implements Serializable

serialVersionUID:

-1706033335L

Serialized Fields

condition

Expression condition

A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.

data

List<DataRequirement> data

The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.

name

StringType name

A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.

timing

Type timing

The timing of the event (if this is a periodic trigger).

type

Enumeration<TriggerDefinition.TriggerType> type

The type of triggering event.

Class org.hl7.fhir.r4.model.TriggerDefinition.TriggerTypeEnumFactory

class TriggerTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.Tuple

class Tuple extends Base implements Serializable

Serialized Fields

properties

Map<String,List<Base>> properties

Class org.hl7.fhir.r4.model.Type

class Type extends Element implements Serializable

serialVersionUID:

4623040030733049991L

Class org.hl7.fhir.r4.model.UnsignedIntType

class UnsignedIntType extends IntegerType implements Externalizable

serialVersionUID:

-7991875974606711355L

Serialization Methods

readExternal

public void readExternal(ObjectInput theIn)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput theOut)
                   throws IOException

Throws:

IOException

Class org.hl7.fhir.r4.model.UriType

class UriType extends PrimitiveType<String> implements Externalizable

serialVersionUID:

3L

Serialization Methods

readExternal

public void readExternal(ObjectInput theIn)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput theOut)
                   throws IOException

Throws:

IOException

Class org.hl7.fhir.r4.model.UrlType

class UrlType extends UriType implements Externalizable

serialVersionUID:

4L

Serialization Methods

readExternal

public void readExternal(ObjectInput theIn)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput theOut)
                   throws IOException

Throws:

IOException

Class org.hl7.fhir.r4.model.UsageContext

class UsageContext extends Type implements Serializable

serialVersionUID:

-1092486508L

Serialized Fields

code

Coding code

A code that identifies the type of context being specified by this usage context.

value

Type value

A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

Class org.hl7.fhir.r4.model.UuidType

class UuidType extends UriType implements Externalizable

serialVersionUID:

3L

Serialization Methods

readExternal

public void readExternal(ObjectInput theIn)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput theOut)
                   throws IOException

Throws:

IOException

Class org.hl7.fhir.r4.model.ValueSet

class ValueSet extends MetadataResource implements Serializable

serialVersionUID:

786712949L

Serialized Fields

compose

ValueSet.ValueSetComposeComponent compose

A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).

copyright

MarkdownType copyright

A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.

expansion

ValueSet.ValueSetExpansionComponent expansion

A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.

identifier

List<Identifier> identifier

A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.

immutable

BooleanType immutable

If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.

purpose

MarkdownType purpose

Explanation of why this value set is needed and why it has been designed as it has.

Class org.hl7.fhir.r4.model.ValueSet.ConceptReferenceComponent

class ConceptReferenceComponent extends BackboneElement implements Serializable

serialVersionUID:

260579971L

Serialized Fields

code

CodeType code

Specifies a code for the concept to be included or excluded.

designation

List<ValueSet.ConceptReferenceDesignationComponent> designation

Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc.

display

StringType display

The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system.

Class org.hl7.fhir.r4.model.ValueSet.ConceptReferenceDesignationComponent

class ConceptReferenceDesignationComponent extends BackboneElement implements Serializable

serialVersionUID:

1515662414L

Serialized Fields

language

CodeType language

The language this designation is defined for.

use

Coding use

A code that represents types of uses of designations.

value

StringType value

The text value for this designation.

Class org.hl7.fhir.r4.model.ValueSet.ConceptSetComponent

class ConceptSetComponent extends BackboneElement implements Serializable

serialVersionUID:

969391146L

Serialized Fields

concept

List<ValueSet.ConceptReferenceComponent> concept

Specifies a concept to be included or excluded.

filter

List<ValueSet.ConceptSetFilterComponent> filter

Select concepts by specify a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified, they SHALL all be true.

system

UriType system

An absolute URI which is the code system from which the selected codes come from.

valueSet

List<CanonicalType> valueSet

Selects the concepts found in this value set (based on its value set definition). This is an absolute URI that is a reference to ValueSet.url. If multiple value sets are specified this includes the union of the contents of all of the referenced value sets.

version

StringType version

The version of the code system that the codes are selected from, or the special version '*' for all versions.

Class org.hl7.fhir.r4.model.ValueSet.ConceptSetFilterComponent

class ConceptSetFilterComponent extends BackboneElement implements Serializable

serialVersionUID:

1259153492L

Serialized Fields

op

Enumeration<ValueSet.FilterOperator> op

The kind of operation to perform as a part of the filter criteria.

property

CodeType property

A code that identifies a property or a filter defined in the code system.

value

StringType value

The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value (if the filter represents a property defined in CodeSystem) or of the system filter value (if the filter represents a filter defined in CodeSystem) when the operation is 'regex', or one of the values (true and false), when the operation is 'exists'.

Class org.hl7.fhir.r4.model.ValueSet.FilterOperatorEnumFactory

class FilterOperatorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.ValueSet.ValueSetComposeComponent

class ValueSetComposeComponent extends BackboneElement implements Serializable

serialVersionUID:

-765941757L

Serialized Fields

exclude

List<ValueSet.ConceptSetComponent> exclude

Exclude one or more codes from the value set based on code system filters and/or other value sets.

inactive

BooleanType inactive

Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included).

include

List<ValueSet.ConceptSetComponent> include

Include one or more codes from a code system or other value set(s).

lockedDate

DateType lockedDate

The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version.

Class org.hl7.fhir.r4.model.ValueSet.ValueSetExpansionComponent

class ValueSetExpansionComponent extends BackboneElement implements Serializable

serialVersionUID:

-43471993L

Serialized Fields

contains

List<ValueSet.ValueSetExpansionContainsComponent> contains

The codes that are contained in the value set expansion.

identifier

UriType identifier

An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier.

offset

IntegerType offset

If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL NOT be present.

parameter

List<ValueSet.ValueSetExpansionParameterComponent> parameter

A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion.

timestamp

DateTimeType timestamp

The time at which the expansion was produced by the expanding system.

total

IntegerType total

The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter.

Class org.hl7.fhir.r4.model.ValueSet.ValueSetExpansionContainsComponent

class ValueSetExpansionContainsComponent extends BackboneElement implements Serializable

serialVersionUID:

719458860L

Serialized Fields

abstract_

BooleanType abstract_

If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.

code

CodeType code

The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.

contains

List<ValueSet.ValueSetExpansionContainsComponent> contains

Other codes and entries contained under this entry in the hierarchy.

designation

List<ValueSet.ConceptReferenceDesignationComponent> designation

Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation.

display

StringType display

The recommended display for this item in the expansion.

inactive

BooleanType inactive

If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether an concept is inactive (and it may depend on the context of use).

system

UriType system

An absolute URI which is the code system in which the code for this item in the expansion is defined.

version

StringType version

The version of the code system from this code was taken. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Class org.hl7.fhir.r4.model.ValueSet.ValueSetExpansionParameterComponent

class ValueSetExpansionParameterComponent extends BackboneElement implements Serializable

serialVersionUID:

1172641169L

Serialized Fields

name

StringType name

Name of the input parameter to the $expand operation; may be a server-assigned name for additional default or other server-supplied parameters used to control the expansion process.

value

Type value

The value of the parameter.

Class org.hl7.fhir.r4.model.VerificationResult

class VerificationResult extends DomainResource implements Serializable

serialVersionUID:

-284059204L

Serialized Fields

attestation

VerificationResult.VerificationResultAttestationComponent attestation

Information about the entity attesting to information.

failureAction

CodeableConcept failureAction

The result if validation fails (fatal; warning; record only; none).

frequency

Timing frequency

Frequency of revalidation.

lastPerformed

DateTimeType lastPerformed

The date/time validation was last completed (including failed validations).

need

CodeableConcept need

The frequency with which the target must be validated (none; initial; periodic).

nextScheduled

DateType nextScheduled

The date when target is next validated, if appropriate.

primarySource

List<VerificationResult.VerificationResultPrimarySourceComponent> primarySource

Information about the primary source(s) involved in validation.

status

Enumeration<VerificationResult.Status> status

The validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed).

statusDate

DateTimeType statusDate

When the validation status was updated.

target

List<Reference> target

A resource that was validated.

targetLocation

List<StringType> targetLocation

The fhirpath location(s) within the resource that was validated.

targetTarget

List<Resource> targetTarget

The actual objects that are the target of the reference (A resource that was validated.)

validationProcess

List<CodeableConcept> validationProcess

The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context).

validationType

CodeableConcept validationType

What the target is validated against (nothing; primary source; multiple sources).

validator

List<VerificationResult.VerificationResultValidatorComponent> validator

Information about the entity validating information.

Class org.hl7.fhir.r4.model.VerificationResult.StatusEnumFactory

class StatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.VerificationResult.VerificationResultAttestationComponent

class VerificationResultAttestationComponent extends BackboneElement implements Serializable

serialVersionUID:

-900018800L

Serialized Fields

communicationMethod

CodeableConcept communicationMethod

The method by which attested information was submitted/retrieved (manual; API; Push).

date

DateType date

The date the information was attested to.

onBehalfOf

Reference onBehalfOf

When the who is asserting on behalf of another (organization or individual).

onBehalfOfTarget

Resource onBehalfOfTarget

The actual object that is the target of the reference (When the who is asserting on behalf of another (organization or individual).)

proxyIdentityCertificate

StringType proxyIdentityCertificate

A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source.

proxySignature

Signature proxySignature

Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source.

sourceIdentityCertificate

StringType sourceIdentityCertificate

A digital identity certificate associated with the attestation source.

sourceSignature

Signature sourceSignature

Signed assertion by the attestation source that they have attested to the information.

who

Reference who

The individual or organization attesting to information.

whoTarget

Resource whoTarget

The actual object that is the target of the reference (The individual or organization attesting to information.)

Class org.hl7.fhir.r4.model.VerificationResult.VerificationResultPrimarySourceComponent

class VerificationResultPrimarySourceComponent extends BackboneElement implements Serializable

serialVersionUID:

-928858332L

Serialized Fields

canPushUpdates

CodeableConcept canPushUpdates

Ability of the primary source to push updates/alerts (yes; no; undetermined).

communicationMethod

List<CodeableConcept> communicationMethod

Method for communicating with the primary source (manual; API; Push).

pushTypeAvailable

List<CodeableConcept> pushTypeAvailable

Type of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source).

type

List<CodeableConcept> type

Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source).

validationDate

DateTimeType validationDate

When the target was validated against the primary source.

validationStatus

CodeableConcept validationStatus

Status of the validation of the target against the primary source (successful; failed; unknown).

who

Reference who

Reference to the primary source.

whoTarget

Resource whoTarget

The actual object that is the target of the reference (Reference to the primary source.)

Class org.hl7.fhir.r4.model.VerificationResult.VerificationResultValidatorComponent

class VerificationResultValidatorComponent extends BackboneElement implements Serializable

serialVersionUID:

35580619L

Serialized Fields

attestationSignature

Signature attestationSignature

Signed assertion by the validator that they have validated the information.

identityCertificate

StringType identityCertificate

A digital identity certificate associated with the validator.

organization

Reference organization

Reference to the organization validating information.

organizationTarget

Organization organizationTarget

The actual object that is the target of the reference (Reference to the organization validating information.)

Class org.hl7.fhir.r4.model.VisionPrescription

class VisionPrescription extends DomainResource implements Serializable

serialVersionUID:

988021071L

Serialized Fields

created

DateTimeType created

The date this resource was created.

dateWritten

DateTimeType dateWritten

The date (and perhaps time) when the prescription was written.

encounter

Reference encounter

A reference to a resource that identifies the particular occurrence of contact between patient and health care provider during which the prescription was issued.

encounterTarget

Encounter encounterTarget

The actual object that is the target of the reference (A reference to a resource that identifies the particular occurrence of contact between patient and health care provider during which the prescription was issued.)

identifier

List<Identifier> identifier

A unique identifier assigned to this vision prescription.

lensSpecification

List<VisionPrescription.VisionPrescriptionLensSpecificationComponent> lensSpecification

Contain the details of the individual lens specifications and serves as the authorization for the fullfillment by certified professionals.

patient

Reference patient

A resource reference to the person to whom the vision prescription applies.

patientTarget

Patient patientTarget

The actual object that is the target of the reference (A resource reference to the person to whom the vision prescription applies.)

prescriber

Reference prescriber

The healthcare professional responsible for authorizing the prescription.

prescriberTarget

Resource prescriberTarget

The actual object that is the target of the reference (The healthcare professional responsible for authorizing the prescription.)

status

Enumeration<VisionPrescription.VisionStatus> status

The status of the resource instance.

Class org.hl7.fhir.r4.model.VisionPrescription.PrismComponent

class PrismComponent extends BackboneElement implements Serializable

serialVersionUID:

1677247628L

Serialized Fields

amount

DecimalType amount

Amount of prism to compensate for eye alignment in fractional units.

base

Enumeration<VisionPrescription.VisionBase> base

The relative base, or reference lens edge, for the prism.

Class org.hl7.fhir.r4.model.VisionPrescription.VisionBaseEnumFactory

class VisionBaseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.VisionPrescription.VisionEyesEnumFactory

class VisionEyesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.VisionPrescription.VisionPrescriptionLensSpecificationComponent

class VisionPrescriptionLensSpecificationComponent extends BackboneElement implements Serializable

serialVersionUID:

688924460L

Serialized Fields

add

DecimalType add

Power adjustment for multifocal lenses measured in dioptres (0.25 units).

axis

IntegerType axis

Adjustment for astigmatism measured in integer degrees.

backCurve

DecimalType backCurve

Back curvature measured in millimetres.

brand

StringType brand

Brand recommendations or restrictions.

color

StringType color

Special color or pattern.

cylinder

DecimalType cylinder

Power adjustment for astigmatism measured in dioptres (0.25 units).

diameter

DecimalType diameter

Contact lens diameter measured in millimetres.

duration

Quantity duration

The recommended maximum wear period for the lens.

eye

Enumeration<VisionPrescription.VisionEyes> eye

The eye for which the lens specification applies.

note

List<Annotation> note

Notes for special requirements such as coatings and lens materials.

power

DecimalType power

Contact lens power measured in dioptres (0.25 units).

prism

List<VisionPrescription.PrismComponent> prism

Allows for adjustment on two axis.

product

CodeableConcept product

Identifies the type of vision correction product which is required for the patient.

sphere

DecimalType sphere

Lens power measured in dioptres (0.25 units).

Class org.hl7.fhir.r4.model.VisionPrescription.VisionStatusEnumFactory

class VisionStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.XhtmlType

class XhtmlType extends Element implements Serializable

Serialized Fields

place

Narrative place

Package org.hl7.fhir.r4.model.codesystems

Class org.hl7.fhir.r4.model.codesystems.AbstractTypesEnumFactory

class AbstractTypesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AccountStatusEnumFactory

class AccountStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ActionCardinalityBehaviorEnumFactory

class ActionCardinalityBehaviorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ActionConditionKindEnumFactory

class ActionConditionKindEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ActionGroupingBehaviorEnumFactory

class ActionGroupingBehaviorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ActionParticipantTypeEnumFactory

class ActionParticipantTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ActionPrecheckBehaviorEnumFactory

class ActionPrecheckBehaviorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ActionRelationshipTypeEnumFactory

class ActionRelationshipTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ActionRequiredBehaviorEnumFactory

class ActionRequiredBehaviorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ActionSelectionBehaviorEnumFactory

class ActionSelectionBehaviorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ActionTypeEnumFactory

class ActionTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ActivityDefinitionCategoryEnumFactory

class ActivityDefinitionCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AdditionalmaterialsEnumFactory

class AdditionalmaterialsEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AddressTypeEnumFactory

class AddressTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AddressUseEnumFactory

class AddressUseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AdjudicationEnumFactory

class AdjudicationEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AdjudicationErrorEnumFactory

class AdjudicationErrorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AdjudicationReasonEnumFactory

class AdjudicationReasonEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AdministrativeGenderEnumFactory

class AdministrativeGenderEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AdverseEventActualityEnumFactory

class AdverseEventActualityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AdverseEventCategoryEnumFactory

class AdverseEventCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AdverseEventCausalityAssessEnumFactory

class AdverseEventCausalityAssessEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AdverseEventCausalityMethodEnumFactory

class AdverseEventCausalityMethodEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AdverseEventOutcomeEnumFactory

class AdverseEventOutcomeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AdverseEventSeriousnessEnumFactory

class AdverseEventSeriousnessEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AdverseEventSeverityEnumFactory

class AdverseEventSeverityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AllergIntolSubstanceExpRiskEnumFactory

class AllergIntolSubstanceExpRiskEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AllergyIntoleranceCategoryEnumFactory

class AllergyIntoleranceCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AllergyintoleranceClinicalEnumFactory

class AllergyintoleranceClinicalEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AllergyIntoleranceCriticalityEnumFactory

class AllergyIntoleranceCriticalityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AllergyIntoleranceTypeEnumFactory

class AllergyIntoleranceTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AllergyintoleranceVerificationEnumFactory

class AllergyintoleranceVerificationEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AnimalGenderstatusEnumFactory

class AnimalGenderstatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AnimalSpeciesEnumFactory

class AnimalSpeciesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AppointmentCancellationReasonEnumFactory

class AppointmentCancellationReasonEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AppointmentstatusEnumFactory

class AppointmentstatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AssertDirectionCodesEnumFactory

class AssertDirectionCodesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AssertOperatorCodesEnumFactory

class AssertOperatorCodesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AssertResponseCodeTypesEnumFactory

class AssertResponseCodeTypesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AssetAvailabilityEnumFactory

class AssetAvailabilityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AuditEntityTypeEnumFactory

class AuditEntityTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AuditEventActionEnumFactory

class AuditEventActionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AuditEventOutcomeEnumFactory

class AuditEventOutcomeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AuditEventTypeEnumFactory

class AuditEventTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.AuditSourceTypeEnumFactory

class AuditSourceTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.BasicResourceTypeEnumFactory

class BasicResourceTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.BenefitNetworkEnumFactory

class BenefitNetworkEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.BenefitTermEnumFactory

class BenefitTermEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.BenefitTypeEnumFactory

class BenefitTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.BenefitUnitEnumFactory

class BenefitUnitEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.BindingStrengthEnumFactory

class BindingStrengthEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.BundleTypeEnumFactory

class BundleTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CapabilityStatementKindEnumFactory

class CapabilityStatementKindEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CarePlanActivityStatusEnumFactory

class CarePlanActivityStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CareTeamStatusEnumFactory

class CareTeamStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CatalogTypeEnumFactory

class CatalogTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CdshooksIndicatorEnumFactory

class CdshooksIndicatorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CertaintySubcomponentRatingEnumFactory

class CertaintySubcomponentRatingEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CertaintySubcomponentTypeEnumFactory

class CertaintySubcomponentTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ChargeitemBillingcodesEnumFactory

class ChargeitemBillingcodesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ChargeitemStatusEnumFactory

class ChargeitemStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ChoiceListOrientationEnumFactory

class ChoiceListOrientationEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ChromosomeHumanEnumFactory

class ChromosomeHumanEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ClaimCareteamroleEnumFactory

class ClaimCareteamroleEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ClaimExceptionEnumFactory

class ClaimExceptionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ClaimInformationcategoryEnumFactory

class ClaimInformationcategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ClaimModifiersEnumFactory

class ClaimModifiersEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ClaimSubtypeEnumFactory

class ClaimSubtypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ClaimTypeEnumFactory

class ClaimTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ClaimUseEnumFactory

class ClaimUseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CodeSearchSupportEnumFactory

class CodeSearchSupportEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CodesystemAltcodeKindEnumFactory

class CodesystemAltcodeKindEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CodesystemContentModeEnumFactory

class CodesystemContentModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CodesystemHierarchyMeaningEnumFactory

class CodesystemHierarchyMeaningEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CommonTagsEnumFactory

class CommonTagsEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CommunicationCategoryEnumFactory

class CommunicationCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CommunicationNotDoneReasonEnumFactory

class CommunicationNotDoneReasonEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CommunicationTopicEnumFactory

class CommunicationTopicEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CompartmentTypeEnumFactory

class CompartmentTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CompositeMeasureScoringEnumFactory

class CompositeMeasureScoringEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CompositionAltcodeKindEnumFactory

class CompositionAltcodeKindEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CompositionAttestationModeEnumFactory

class CompositionAttestationModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CompositionStatusEnumFactory

class CompositionStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ConceptMapEquivalenceEnumFactory

class ConceptMapEquivalenceEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ConceptmapUnmappedModeEnumFactory

class ConceptmapUnmappedModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ConceptPropertiesEnumFactory

class ConceptPropertiesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ConceptPropertyTypeEnumFactory

class ConceptPropertyTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ConceptSubsumptionOutcomeEnumFactory

class ConceptSubsumptionOutcomeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ConditionalDeleteStatusEnumFactory

class ConditionalDeleteStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ConditionalReadStatusEnumFactory

class ConditionalReadStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ConditionCategoryEnumFactory

class ConditionCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ConditionClinicalEnumFactory

class ConditionClinicalEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ConditionStateEnumFactory

class ConditionStateEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ConditionVerStatusEnumFactory

class ConditionVerStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ConformanceExpectationEnumFactory

class ConformanceExpectationEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ConsentActionEnumFactory

class ConsentActionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ConsentCategoryEnumFactory

class ConsentCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ConsentDataMeaningEnumFactory

class ConsentDataMeaningEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ConsentPerformerEnumFactory

class ConsentPerformerEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ConsentPolicyEnumFactory

class ConsentPolicyEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ConsentProvisionTypeEnumFactory

class ConsentProvisionTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ConsentScopeEnumFactory

class ConsentScopeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ConsentStateCodesEnumFactory

class ConsentStateCodesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ConstraintSeverityEnumFactory

class ConstraintSeverityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContactentityTypeEnumFactory

class ContactentityTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContactPointSystemEnumFactory

class ContactPointSystemEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContactPointUseEnumFactory

class ContactPointUseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContainerCapEnumFactory

class ContainerCapEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractActionEnumFactory

class ContractActionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractActionstatusEnumFactory

class ContractActionstatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractActorroleEnumFactory

class ContractActorroleEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractAssetcontextEnumFactory

class ContractAssetcontextEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractAssetscopeEnumFactory

class ContractAssetscopeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractAssetsubtypeEnumFactory

class ContractAssetsubtypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractAssettypeEnumFactory

class ContractAssettypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractContentDerivativeEnumFactory

class ContractContentDerivativeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractDataMeaningEnumFactory

class ContractDataMeaningEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractDecisionModeEnumFactory

class ContractDecisionModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractDefinitionSubtypeEnumFactory

class ContractDefinitionSubtypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractDefinitionTypeEnumFactory

class ContractDefinitionTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractExpirationTypeEnumFactory

class ContractExpirationTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractLegalstateEnumFactory

class ContractLegalstateEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractPartyRoleEnumFactory

class ContractPartyRoleEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractPublicationstatusEnumFactory

class ContractPublicationstatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractScopeEnumFactory

class ContractScopeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractSecurityCategoryEnumFactory

class ContractSecurityCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractSecurityClassificationEnumFactory

class ContractSecurityClassificationEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractSecurityControlEnumFactory

class ContractSecurityControlEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractSignerTypeEnumFactory

class ContractSignerTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractStatusEnumFactory

class ContractStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractSubtypeEnumFactory

class ContractSubtypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractTermSubtypeEnumFactory

class ContractTermSubtypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractTermTypeEnumFactory

class ContractTermTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContractTypeEnumFactory

class ContractTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ContributorTypeEnumFactory

class ContributorTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CopyNumberEventEnumFactory

class CopyNumberEventEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CoverageClassEnumFactory

class CoverageClassEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CoverageCopayTypeEnumFactory

class CoverageCopayTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CoverageeligibilityresponseExAuthSupportEnumFactory

class CoverageeligibilityresponseExAuthSupportEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CoverageFinancialExceptionEnumFactory

class CoverageFinancialExceptionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.CoverageSelfpayEnumFactory

class CoverageSelfpayEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.DataAbsentReasonEnumFactory

class DataAbsentReasonEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.DataTypesEnumFactory

class DataTypesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.DaysOfWeekEnumFactory

class DaysOfWeekEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.DefinitionResourceTypesEnumFactory

class DefinitionResourceTypesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.DefinitionStatusEnumFactory

class DefinitionStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.DefinitionTopicEnumFactory

class DefinitionTopicEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.DefinitionUseEnumFactory

class DefinitionUseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.DetectedissueSeverityEnumFactory

class DetectedissueSeverityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.DeviceActionEnumFactory

class DeviceActionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.DeviceDefinitionStatusEnumFactory

class DeviceDefinitionStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.DeviceNametypeEnumFactory

class DeviceNametypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.DeviceStatementStatusEnumFactory

class DeviceStatementStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.DeviceStatusEnumFactory

class DeviceStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.DeviceStatusReasonEnumFactory

class DeviceStatusReasonEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.DiagnosisRoleEnumFactory

class DiagnosisRoleEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.DiagnosticReportStatusEnumFactory

class DiagnosticReportStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.DicomAuditLifecycleEnumFactory

class DicomAuditLifecycleEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.DiscriminatorTypeEnumFactory

class DiscriminatorTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.DocumentModeEnumFactory

class DocumentModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.DocumentReferenceStatusEnumFactory

class DocumentReferenceStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.DocumentRelationshipTypeEnumFactory

class DocumentRelationshipTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.DoseRateTypeEnumFactory

class DoseRateTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.EffectEstimateTypeEnumFactory

class EffectEstimateTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.EligibilityrequestPurposeEnumFactory

class EligibilityrequestPurposeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.EligibilityresponsePurposeEnumFactory

class EligibilityresponsePurposeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.EncounterAdmitSourceEnumFactory

class EncounterAdmitSourceEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.EncounterDietEnumFactory

class EncounterDietEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.EncounterDischargeDispositionEnumFactory

class EncounterDischargeDispositionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.EncounterLocationStatusEnumFactory

class EncounterLocationStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.EncounterParticipantTypeEnumFactory

class EncounterParticipantTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.EncounterSpecialArrangementsEnumFactory

class EncounterSpecialArrangementsEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.EncounterStatusEnumFactory

class EncounterStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.EncounterTypeEnumFactory

class EncounterTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.EndpointConnectionTypeEnumFactory

class EndpointConnectionTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.EndpointPayloadTypeEnumFactory

class EndpointPayloadTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.EndpointStatusEnumFactory

class EndpointStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.EntformulaAdditiveEnumFactory

class EntformulaAdditiveEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.EpisodeOfCareStatusEnumFactory

class EpisodeOfCareStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.EpisodeofcareTypeEnumFactory

class EpisodeofcareTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.EventCapabilityModeEnumFactory

class EventCapabilityModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.EventResourceTypesEnumFactory

class EventResourceTypesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.EventStatusEnumFactory

class EventStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.EventTimingEnumFactory

class EventTimingEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.EvidenceQualityEnumFactory

class EvidenceQualityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.EvidenceVariantStateEnumFactory

class EvidenceVariantStateEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ExamplescenarioActorTypeEnumFactory

class ExamplescenarioActorTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ExBenefitcategoryEnumFactory

class ExBenefitcategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ExDiagnosisOnAdmissionEnumFactory

class ExDiagnosisOnAdmissionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ExDiagnosisrelatedgroupEnumFactory

class ExDiagnosisrelatedgroupEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ExDiagnosistypeEnumFactory

class ExDiagnosistypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ExOnsettypeEnumFactory

class ExOnsettypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ExpansionParameterSourceEnumFactory

class ExpansionParameterSourceEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ExpansionProcessingRuleEnumFactory

class ExpansionProcessingRuleEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ExPayeeResourceTypeEnumFactory

class ExPayeeResourceTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ExPaymenttypeEnumFactory

class ExPaymenttypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ExplanationofbenefitStatusEnumFactory

class ExplanationofbenefitStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ExposureStateEnumFactory

class ExposureStateEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ExpressionLanguageEnumFactory

class ExpressionLanguageEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ExProcedureTypeEnumFactory

class ExProcedureTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ExProgramCodeEnumFactory

class ExProgramCodeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ExRevenueCenterEnumFactory

class ExRevenueCenterEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ExtensionContextTypeEnumFactory

class ExtensionContextTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ExtraActivityTypeEnumFactory

class ExtraActivityTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ExtraSecurityRoleTypeEnumFactory

class ExtraSecurityRoleTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.FeedingDeviceEnumFactory

class FeedingDeviceEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.FHIRVersionEnumFactory

class FHIRVersionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.FilterOperatorEnumFactory

class FilterOperatorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.FinancialTaskcodeEnumFactory

class FinancialTaskcodeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.FinancialTaskinputtypeEnumFactory

class FinancialTaskinputtypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.FlagCategoryEnumFactory

class FlagCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.FlagPriorityEnumFactory

class FlagPriorityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.FlagStatusEnumFactory

class FlagStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.FmConditionsEnumFactory

class FmConditionsEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.FmItemtypeEnumFactory

class FmItemtypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.FmStatusEnumFactory

class FmStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.FormsEnumFactory

class FormsEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.FundsreserveEnumFactory

class FundsreserveEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.GenderIdentityEnumFactory

class GenderIdentityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.GoalAcceptanceStatusEnumFactory

class GoalAcceptanceStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.GoalAchievementEnumFactory

class GoalAchievementEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.GoalCategoryEnumFactory

class GoalCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.GoalPriorityEnumFactory

class GoalPriorityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.GoalRelationshipTypeEnumFactory

class GoalRelationshipTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.GoalStatusEnumFactory

class GoalStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.GoalStatusReasonEnumFactory

class GoalStatusReasonEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.GraphCompartmentRuleEnumFactory

class GraphCompartmentRuleEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.GraphCompartmentUseEnumFactory

class GraphCompartmentUseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.GroupMeasureEnumFactory

class GroupMeasureEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.GroupTypeEnumFactory

class GroupTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.GuidanceResponseStatusEnumFactory

class GuidanceResponseStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.GuidePageGenerationEnumFactory

class GuidePageGenerationEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.GuideParameterCodeEnumFactory

class GuideParameterCodeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.HandlingConditionEnumFactory

class HandlingConditionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.HistoryAbsentReasonEnumFactory

class HistoryAbsentReasonEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.HistoryStatusEnumFactory

class HistoryStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.Hl7WorkGroupEnumFactory

class Hl7WorkGroupEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.HttpOperationsEnumFactory

class HttpOperationsEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.HttpVerbEnumFactory

class HttpVerbEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.Icd10ProceduresEnumFactory

class Icd10ProceduresEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.IdentifierUseEnumFactory

class IdentifierUseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.IdentityAssuranceLevelEnumFactory

class IdentityAssuranceLevelEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.IHEFormatcodeCsEnumFactory

class IHEFormatcodeCsEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ImagingstudyStatusEnumFactory

class ImagingstudyStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ImmunizationEvaluationDoseStatusEnumFactory

class ImmunizationEvaluationDoseStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ImmunizationEvaluationDoseStatusReasonEnumFactory

class ImmunizationEvaluationDoseStatusReasonEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ImmunizationFundingSourceEnumFactory

class ImmunizationFundingSourceEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ImmunizationOriginEnumFactory

class ImmunizationOriginEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ImmunizationProgramEligibilityEnumFactory

class ImmunizationProgramEligibilityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ImmunizationRecommendationStatusEnumFactory

class ImmunizationRecommendationStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ImmunizationSubpotentReasonEnumFactory

class ImmunizationSubpotentReasonEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ImplantStatusEnumFactory

class ImplantStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.InsuranceplanApplicabilityEnumFactory

class InsuranceplanApplicabilityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.InsuranceplanTypeEnumFactory

class InsuranceplanTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.InterventionEnumFactory

class InterventionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.InvoicePriceComponentTypeEnumFactory

class InvoicePriceComponentTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.InvoiceStatusEnumFactory

class InvoiceStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.Iso21089LifecycleEnumFactory

class Iso21089LifecycleEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.IssueSeverityEnumFactory

class IssueSeverityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.IssueTypeEnumFactory

class IssueTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ItemTypeEnumFactory

class ItemTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.KnowledgeResourceTypesEnumFactory

class KnowledgeResourceTypesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.LanguagePreferenceTypeEnumFactory

class LanguagePreferenceTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.LibraryTypeEnumFactory

class LibraryTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.LinkageTypeEnumFactory

class LinkageTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.LinkTypeEnumFactory

class LinkTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ListEmptyReasonEnumFactory

class ListEmptyReasonEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ListExampleCodesEnumFactory

class ListExampleCodesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ListItemFlagEnumFactory

class ListItemFlagEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ListModeEnumFactory

class ListModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ListOrderEnumFactory

class ListOrderEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ListStatusEnumFactory

class ListStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.LocationModeEnumFactory

class LocationModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.LocationPhysicalTypeEnumFactory

class LocationPhysicalTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.LocationStatusEnumFactory

class LocationStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MapContextTypeEnumFactory

class MapContextTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MapGroupTypeModeEnumFactory

class MapGroupTypeModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MapInputModeEnumFactory

class MapInputModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MapModelModeEnumFactory

class MapModelModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MapSourceListModeEnumFactory

class MapSourceListModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MapTargetListModeEnumFactory

class MapTargetListModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MapTransformEnumFactory

class MapTransformEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MatchGradeEnumFactory

class MatchGradeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MeasureDataUsageEnumFactory

class MeasureDataUsageEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MeasureImprovementNotationEnumFactory

class MeasureImprovementNotationEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MeasurePopulationEnumFactory

class MeasurePopulationEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MeasureReportStatusEnumFactory

class MeasureReportStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MeasureReportTypeEnumFactory

class MeasureReportTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MeasureScoringEnumFactory

class MeasureScoringEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MeasureTypeEnumFactory

class MeasureTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MedAdminPerformFunctionEnumFactory

class MedAdminPerformFunctionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MediaModalityEnumFactory

class MediaModalityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MediaTypeEnumFactory

class MediaTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MedicationAdminCategoryEnumFactory

class MedicationAdminCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MedicationAdminStatusEnumFactory

class MedicationAdminStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MedicationdispenseCategoryEnumFactory

class MedicationdispenseCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MedicationdispensePerformerFunctionEnumFactory

class MedicationdispensePerformerFunctionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MedicationdispenseStatusEnumFactory

class MedicationdispenseStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MedicationdispenseStatusReasonEnumFactory

class MedicationdispenseStatusReasonEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MedicationknowledgeCharacteristicEnumFactory

class MedicationknowledgeCharacteristicEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MedicationknowledgePackageTypeEnumFactory

class MedicationknowledgePackageTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MedicationknowledgeStatusEnumFactory

class MedicationknowledgeStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MedicationrequestCategoryEnumFactory

class MedicationrequestCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MedicationrequestCourseOfTherapyEnumFactory

class MedicationrequestCourseOfTherapyEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MedicationrequestIntentEnumFactory

class MedicationrequestIntentEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MedicationrequestStatusEnumFactory

class MedicationrequestStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MedicationrequestStatusReasonEnumFactory

class MedicationrequestStatusReasonEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MedicationStatementCategoryEnumFactory

class MedicationStatementCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MedicationStatementStatusEnumFactory

class MedicationStatementStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MedicationStatusEnumFactory

class MedicationStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MessageEventsEnumFactory

class MessageEventsEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MessageheaderResponseRequestEnumFactory

class MessageheaderResponseRequestEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MessageReasonEncounterEnumFactory

class MessageReasonEncounterEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MessageSignificanceCategoryEnumFactory

class MessageSignificanceCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MessageTransportEnumFactory

class MessageTransportEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MetricCalibrationStateEnumFactory

class MetricCalibrationStateEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MetricCalibrationTypeEnumFactory

class MetricCalibrationTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MetricCategoryEnumFactory

class MetricCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MetricColorEnumFactory

class MetricColorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MetricOperationalStatusEnumFactory

class MetricOperationalStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.MissingToothReasonEnumFactory

class MissingToothReasonEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.NameAssemblyOrderEnumFactory

class NameAssemblyOrderEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.NameUseEnumFactory

class NameUseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.NamingsystemIdentifierTypeEnumFactory

class NamingsystemIdentifierTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.NamingsystemTypeEnumFactory

class NamingsystemTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.NarrativeStatusEnumFactory

class NarrativeStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.NetworkTypeEnumFactory

class NetworkTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.NoteTypeEnumFactory

class NoteTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ObjectRoleEnumFactory

class ObjectRoleEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ObservationCategoryEnumFactory

class ObservationCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ObservationRangeCategoryEnumFactory

class ObservationRangeCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ObservationStatisticsEnumFactory

class ObservationStatisticsEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ObservationStatusEnumFactory

class ObservationStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.OperationKindEnumFactory

class OperationKindEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.OperationOutcomeEnumFactory

class OperationOutcomeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.OperationParameterUseEnumFactory

class OperationParameterUseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.OralProsthodonticMaterialEnumFactory

class OralProsthodonticMaterialEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.OrganizationRoleEnumFactory

class OrganizationRoleEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.OrganizationTypeEnumFactory

class OrganizationTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.OrientationTypeEnumFactory

class OrientationTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ParameterGroupEnumFactory

class ParameterGroupEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ParticipantrequiredEnumFactory

class ParticipantrequiredEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ParticipationstatusEnumFactory

class ParticipationstatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.PayeetypeEnumFactory

class PayeetypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.PaymentAdjustmentReasonEnumFactory

class PaymentAdjustmentReasonEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.PaymentStatusEnumFactory

class PaymentStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.PaymentTypeEnumFactory

class PaymentTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.PermittedDataTypeEnumFactory

class PermittedDataTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.PlanDefinitionTypeEnumFactory

class PlanDefinitionTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.PractitionerRoleEnumFactory

class PractitionerRoleEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.PractitionerSpecialtyEnumFactory

class PractitionerSpecialtyEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.PrecisionEstimateTypeEnumFactory

class PrecisionEstimateTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ProcedureProgressStatusCodesEnumFactory

class ProcedureProgressStatusCodesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ProcessPriorityEnumFactory

class ProcessPriorityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ProductCategoryEnumFactory

class ProductCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ProductStatusEnumFactory

class ProductStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ProductStorageScaleEnumFactory

class ProductStorageScaleEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ProgramEnumFactory

class ProgramEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.PropertyRepresentationEnumFactory

class PropertyRepresentationEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ProvenanceAgentRoleEnumFactory

class ProvenanceAgentRoleEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ProvenanceAgentTypeEnumFactory

class ProvenanceAgentTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ProvenanceEntityRoleEnumFactory

class ProvenanceEntityRoleEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ProviderQualificationEnumFactory

class ProviderQualificationEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.PublicationStatusEnumFactory

class PublicationStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.QualityTypeEnumFactory

class QualityTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.QuantityComparatorEnumFactory

class QuantityComparatorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.QuestionMaxOccursEnumFactory

class QuestionMaxOccursEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.QuestionnaireAnswersStatusEnumFactory

class QuestionnaireAnswersStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.QuestionnaireDisplayCategoryEnumFactory

class QuestionnaireDisplayCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.QuestionnaireEnableBehaviorEnumFactory

class QuestionnaireEnableBehaviorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.QuestionnaireEnableOperatorEnumFactory

class QuestionnaireEnableOperatorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.QuestionnaireItemControlEnumFactory

class QuestionnaireItemControlEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.QuestionnaireUsageModeEnumFactory

class QuestionnaireUsageModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ReactionEventCertaintyEnumFactory

class ReactionEventCertaintyEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ReactionEventSeverityEnumFactory

class ReactionEventSeverityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ReasonMedicationGivenCodesEnumFactory

class ReasonMedicationGivenCodesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ReasonMedicationNotGivenCodesEnumFactory

class ReasonMedicationNotGivenCodesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.RecommendationStrengthEnumFactory

class RecommendationStrengthEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ReferenceHandlingPolicyEnumFactory

class ReferenceHandlingPolicyEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ReferencerangeMeaningEnumFactory

class ReferencerangeMeaningEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ReferenceVersionRulesEnumFactory

class ReferenceVersionRulesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.RejectionCriteriaEnumFactory

class RejectionCriteriaEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.RelatedArtifactTypeEnumFactory

class RelatedArtifactTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.RelatedClaimRelationshipEnumFactory

class RelatedClaimRelationshipEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.RelationshipEnumFactory

class RelationshipEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.RelationTypeEnumFactory

class RelationTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.RemittanceOutcomeEnumFactory

class RemittanceOutcomeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ReportActionResultCodesEnumFactory

class ReportActionResultCodesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ReportParticipantTypeEnumFactory

class ReportParticipantTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ReportResultCodesEnumFactory

class ReportResultCodesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ReportStatusCodesEnumFactory

class ReportStatusCodesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.RepositoryTypeEnumFactory

class RepositoryTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.RequestIntentEnumFactory

class RequestIntentEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.RequestPriorityEnumFactory

class RequestPriorityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.RequestResourceTypesEnumFactory

class RequestResourceTypesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.RequestStatusEnumFactory

class RequestStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ResearchElementTypeEnumFactory

class ResearchElementTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ResearchStudyObjectiveTypeEnumFactory

class ResearchStudyObjectiveTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ResearchStudyPhaseEnumFactory

class ResearchStudyPhaseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ResearchStudyPrimPurpTypeEnumFactory

class ResearchStudyPrimPurpTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ResearchStudyReasonStoppedEnumFactory

class ResearchStudyReasonStoppedEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ResearchStudyStatusEnumFactory

class ResearchStudyStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ResearchSubjectStatusEnumFactory

class ResearchSubjectStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ResourceAggregationModeEnumFactory

class ResourceAggregationModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ResourceSecurityCategoryEnumFactory

class ResourceSecurityCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ResourceSlicingRulesEnumFactory

class ResourceSlicingRulesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ResourceStatusEnumFactory

class ResourceStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ResourceTypeLinkEnumFactory

class ResourceTypeLinkEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ResourceTypesEnumFactory

class ResourceTypesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ResourceValidationModeEnumFactory

class ResourceValidationModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ResponseCodeEnumFactory

class ResponseCodeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.RestfulCapabilityModeEnumFactory

class RestfulCapabilityModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.RestfulInteractionEnumFactory

class RestfulInteractionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.RestfulSecurityServiceEnumFactory

class RestfulSecurityServiceEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.RiskEstimateTypeEnumFactory

class RiskEstimateTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.RiskProbabilityEnumFactory

class RiskProbabilityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SearchComparatorEnumFactory

class SearchComparatorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SearchEntryModeEnumFactory

class SearchEntryModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SearchModifierCodeEnumFactory

class SearchModifierCodeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SearchParamTypeEnumFactory

class SearchParamTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SearchXpathUsageEnumFactory

class SearchXpathUsageEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SecondaryFindingEnumFactory

class SecondaryFindingEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SequenceTypeEnumFactory

class SequenceTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ServiceCategoryEnumFactory

class ServiceCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ServiceModifiersEnumFactory

class ServiceModifiersEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ServicePharmacyEnumFactory

class ServicePharmacyEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ServicePlaceEnumFactory

class ServicePlaceEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ServiceProductEnumFactory

class ServiceProductEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ServiceProvisionConditionsEnumFactory

class ServiceProvisionConditionsEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ServiceReferralMethodEnumFactory

class ServiceReferralMethodEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ServiceTypeEnumFactory

class ServiceTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ServiceUsclsEnumFactory

class ServiceUsclsEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SignatureTypeEnumFactory

class SignatureTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SlotstatusEnumFactory

class SlotstatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SmartCapabilitiesEnumFactory

class SmartCapabilitiesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SortDirectionEnumFactory

class SortDirectionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SpdxLicenseEnumFactory

class SpdxLicenseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SpecialValuesEnumFactory

class SpecialValuesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SpecimenContainedPreferenceEnumFactory

class SpecimenContainedPreferenceEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SpecimenStatusEnumFactory

class SpecimenStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.StandardsStatusEnumFactory

class StandardsStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.StrandTypeEnumFactory

class StrandTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.StructureDefinitionKindEnumFactory

class StructureDefinitionKindEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.StudyTypeEnumFactory

class StudyTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SubscriberRelationshipEnumFactory

class SubscriberRelationshipEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SubscriptionChannelTypeEnumFactory

class SubscriptionChannelTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SubscriptionStatusEnumFactory

class SubscriptionStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SubscriptionTagEnumFactory

class SubscriptionTagEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SubstanceCategoryEnumFactory

class SubstanceCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SubstanceStatusEnumFactory

class SubstanceStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SupplydeliveryStatusEnumFactory

class SupplydeliveryStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SupplydeliveryTypeEnumFactory

class SupplydeliveryTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SupplyrequestKindEnumFactory

class SupplyrequestKindEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SupplyrequestReasonEnumFactory

class SupplyrequestReasonEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SupplyrequestStatusEnumFactory

class SupplyrequestStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SurfaceEnumFactory

class SurfaceEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.SynthesisTypeEnumFactory

class SynthesisTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.TaskCodeEnumFactory

class TaskCodeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.TaskIntentEnumFactory

class TaskIntentEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.TaskStatusEnumFactory

class TaskStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.TeethEnumFactory

class TeethEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.TestscriptOperationCodesEnumFactory

class TestscriptOperationCodesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.TestscriptProfileDestinationTypesEnumFactory

class TestscriptProfileDestinationTypesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.TestscriptProfileOriginTypesEnumFactory

class TestscriptProfileOriginTypesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.TldcEnumFactory

class TldcEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.ToothEnumFactory

class ToothEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.TransactionModeEnumFactory

class TransactionModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.TriggerTypeEnumFactory

class TriggerTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.TypeDerivationRuleEnumFactory

class TypeDerivationRuleEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.UdiEntryTypeEnumFactory

class UdiEntryTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.UdiEnumFactory

class UdiEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.UnknownContentCodeEnumFactory

class UnknownContentCodeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.UsageContextTypeEnumFactory

class UsageContextTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3AcknowledgementConditionEnumFactory

class V3AcknowledgementConditionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3AcknowledgementDetailCodeEnumFactory

class V3AcknowledgementDetailCodeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3AcknowledgementDetailTypeEnumFactory

class V3AcknowledgementDetailTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3AcknowledgementTypeEnumFactory

class V3AcknowledgementTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ActClassEnumFactory

class V3ActClassEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ActCodeEnumFactory

class V3ActCodeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ActExposureLevelCodeEnumFactory

class V3ActExposureLevelCodeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ActInvoiceElementModifierEnumFactory

class V3ActInvoiceElementModifierEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ActMoodEnumFactory

class V3ActMoodEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ActPriorityEnumFactory

class V3ActPriorityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ActReasonEnumFactory

class V3ActReasonEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ActRelationshipCheckpointEnumFactory

class V3ActRelationshipCheckpointEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ActRelationshipJoinEnumFactory

class V3ActRelationshipJoinEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ActRelationshipSplitEnumFactory

class V3ActRelationshipSplitEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ActRelationshipSubsetEnumFactory

class V3ActRelationshipSubsetEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ActRelationshipTypeEnumFactory

class V3ActRelationshipTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ActSiteEnumFactory

class V3ActSiteEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ActStatusEnumFactory

class V3ActStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ActUncertaintyEnumFactory

class V3ActUncertaintyEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ActUSPrivacyLawEnumFactory

class V3ActUSPrivacyLawEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3AddressPartTypeEnumFactory

class V3AddressPartTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3AddressUseEnumFactory

class V3AddressUseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3AdministrativeGenderEnumFactory

class V3AdministrativeGenderEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3AmericanIndianAlaskaNativeLanguagesEnumFactory

class V3AmericanIndianAlaskaNativeLanguagesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3CalendarCycleEnumFactory

class V3CalendarCycleEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3CalendarEnumFactory

class V3CalendarEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3CalendarTypeEnumFactory

class V3CalendarTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3CharsetEnumFactory

class V3CharsetEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3CodingRationaleEnumFactory

class V3CodingRationaleEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3CommunicationFunctionTypeEnumFactory

class V3CommunicationFunctionTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3CompressionAlgorithmEnumFactory

class V3CompressionAlgorithmEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ConfidentialityEnumFactory

class V3ConfidentialityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ContainerCapEnumFactory

class V3ContainerCapEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ContainerSeparatorEnumFactory

class V3ContainerSeparatorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ContentProcessingModeEnumFactory

class V3ContentProcessingModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ContextControlEnumFactory

class V3ContextControlEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3DataOperationEnumFactory

class V3DataOperationEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3DentitionEnumFactory

class V3DentitionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3DeviceAlertLevelEnumFactory

class V3DeviceAlertLevelEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3DocumentCompletionEnumFactory

class V3DocumentCompletionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3DocumentStorageEnumFactory

class V3DocumentStorageEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3EducationLevelEnumFactory

class V3EducationLevelEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3EmployeeJobClassEnumFactory

class V3EmployeeJobClassEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3EncounterAdmissionSourceEnumFactory

class V3EncounterAdmissionSourceEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3EncounterSpecialCourtesyEnumFactory

class V3EncounterSpecialCourtesyEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3EntityClassEnumFactory

class V3EntityClassEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3EntityCodeEnumFactory

class V3EntityCodeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3EntityDeterminerEnumFactory

class V3EntityDeterminerEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3EntityHandlingEnumFactory

class V3EntityHandlingEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3EntityNamePartQualifierEnumFactory

class V3EntityNamePartQualifierEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3EntityNamePartQualifierR2EnumFactory

class V3EntityNamePartQualifierR2EnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3EntityNamePartTypeEnumFactory

class V3EntityNamePartTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3EntityNamePartTypeR2EnumFactory

class V3EntityNamePartTypeR2EnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3EntityNameUseEnumFactory

class V3EntityNameUseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3EntityNameUseR2EnumFactory

class V3EntityNameUseR2EnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3EntityRiskEnumFactory

class V3EntityRiskEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3EntityStatusEnumFactory

class V3EntityStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3EquipmentAlertLevelEnumFactory

class V3EquipmentAlertLevelEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3EthnicityEnumFactory

class V3EthnicityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ExposureModeEnumFactory

class V3ExposureModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3GenderStatusEnumFactory

class V3GenderStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3GTSAbbreviationEnumFactory

class V3GTSAbbreviationEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3Hl7ApprovalStatusEnumFactory

class V3Hl7ApprovalStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3Hl7CMETAttributionEnumFactory

class V3Hl7CMETAttributionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3HL7ContextConductionStyleEnumFactory

class V3HL7ContextConductionStyleEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3Hl7ITSTypeEnumFactory

class V3Hl7ITSTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3Hl7ITSVersionCodeEnumFactory

class V3Hl7ITSVersionCodeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3Hl7PublishingDomainEnumFactory

class V3Hl7PublishingDomainEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3Hl7PublishingSectionEnumFactory

class V3Hl7PublishingSectionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3Hl7PublishingSubSectionEnumFactory

class V3Hl7PublishingSubSectionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3Hl7RealmEnumFactory

class V3Hl7RealmEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3HL7StandardVersionCodeEnumFactory

class V3HL7StandardVersionCodeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3HL7UpdateModeEnumFactory

class V3HL7UpdateModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3Hl7V3ConformanceEnumFactory

class V3Hl7V3ConformanceEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3Hl7VoteResolutionEnumFactory

class V3Hl7VoteResolutionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3HtmlLinkTypeEnumFactory

class V3HtmlLinkTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3IdentifierReliabilityEnumFactory

class V3IdentifierReliabilityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3IdentifierScopeEnumFactory

class V3IdentifierScopeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3IntegrityCheckAlgorithmEnumFactory

class V3IntegrityCheckAlgorithmEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3LanguageAbilityModeEnumFactory

class V3LanguageAbilityModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3LanguageAbilityProficiencyEnumFactory

class V3LanguageAbilityProficiencyEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3LivingArrangementEnumFactory

class V3LivingArrangementEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3LocalMarkupIgnoreEnumFactory

class V3LocalMarkupIgnoreEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3LocalRemoteControlStateEnumFactory

class V3LocalRemoteControlStateEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ManagedParticipationStatusEnumFactory

class V3ManagedParticipationStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3MapRelationshipEnumFactory

class V3MapRelationshipEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3MaritalStatusEnumFactory

class V3MaritalStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3MessageWaitingPriorityEnumFactory

class V3MessageWaitingPriorityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ModifyIndicatorEnumFactory

class V3ModifyIndicatorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3NullFlavorEnumFactory

class V3NullFlavorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ObservationCategoryEnumFactory

class V3ObservationCategoryEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ObservationInterpretationEnumFactory

class V3ObservationInterpretationEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ObservationMethodEnumFactory

class V3ObservationMethodEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ObservationValueEnumFactory

class V3ObservationValueEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3OrderableDrugFormEnumFactory

class V3OrderableDrugFormEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ParticipationFunctionEnumFactory

class V3ParticipationFunctionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ParticipationModeEnumFactory

class V3ParticipationModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ParticipationSignatureEnumFactory

class V3ParticipationSignatureEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ParticipationTypeEnumFactory

class V3ParticipationTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3PatientImportanceEnumFactory

class V3PatientImportanceEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3PaymentTermsEnumFactory

class V3PaymentTermsEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3PersonDisabilityTypeEnumFactory

class V3PersonDisabilityTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3PolicyHolderRoleEnumFactory

class V3PolicyHolderRoleEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ProbabilityDistributionTypeEnumFactory

class V3ProbabilityDistributionTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ProcessingIDEnumFactory

class V3ProcessingIDEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ProcessingModeEnumFactory

class V3ProcessingModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3QueryParameterValueEnumFactory

class V3QueryParameterValueEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3QueryPriorityEnumFactory

class V3QueryPriorityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3QueryRequestLimitEnumFactory

class V3QueryRequestLimitEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3QueryResponseEnumFactory

class V3QueryResponseEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3QueryStatusCodeEnumFactory

class V3QueryStatusCodeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3RaceEnumFactory

class V3RaceEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3RelationalOperatorEnumFactory

class V3RelationalOperatorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3RelationshipConjunctionEnumFactory

class V3RelationshipConjunctionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ReligiousAffiliationEnumFactory

class V3ReligiousAffiliationEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ResponseLevelEnumFactory

class V3ResponseLevelEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ResponseModalityEnumFactory

class V3ResponseModalityEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3ResponseModeEnumFactory

class V3ResponseModeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3RoleClassEnumFactory

class V3RoleClassEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3RoleCodeEnumFactory

class V3RoleCodeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3RoleLinkStatusEnumFactory

class V3RoleLinkStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3RoleLinkTypeEnumFactory

class V3RoleLinkTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3RoleStatusEnumFactory

class V3RoleStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3RouteOfAdministrationEnumFactory

class V3RouteOfAdministrationEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3SequencingEnumFactory

class V3SequencingEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3SetOperatorEnumFactory

class V3SetOperatorEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3SpecimenTypeEnumFactory

class V3SpecimenTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3StyleTypeEnumFactory

class V3StyleTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3SubstanceAdminSubstitutionEnumFactory

class V3SubstanceAdminSubstitutionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3SubstitutionConditionEnumFactory

class V3SubstitutionConditionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3TableCellHorizontalAlignEnumFactory

class V3TableCellHorizontalAlignEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3TableCellScopeEnumFactory

class V3TableCellScopeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3TableCellVerticalAlignEnumFactory

class V3TableCellVerticalAlignEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3TableFrameEnumFactory

class V3TableFrameEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3TableRulesEnumFactory

class V3TableRulesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3TargetAwarenessEnumFactory

class V3TargetAwarenessEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3TelecommunicationCapabilitiesEnumFactory

class V3TelecommunicationCapabilitiesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3TimingEventEnumFactory

class V3TimingEventEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3TransmissionRelationshipTypeCodeEnumFactory

class V3TransmissionRelationshipTypeCodeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3TribalEntityUSEnumFactory

class V3TribalEntityUSEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3TriggerEventIDEnumFactory

class V3TriggerEventIDEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3VaccineManufacturerEnumFactory

class V3VaccineManufacturerEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.V3WorkClassificationODHEnumFactory

class V3WorkClassificationODHEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.VariableTypeEnumFactory

class VariableTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.VariantStateEnumFactory

class VariantStateEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.VerificationresultCanPushUpdatesEnumFactory

class VerificationresultCanPushUpdatesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.VerificationresultCommunicationMethodEnumFactory

class VerificationresultCommunicationMethodEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.VerificationresultFailureActionEnumFactory

class VerificationresultFailureActionEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.VerificationresultNeedEnumFactory

class VerificationresultNeedEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.VerificationresultPrimarySourceTypeEnumFactory

class VerificationresultPrimarySourceTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.VerificationresultPushTypeAvailableEnumFactory

class VerificationresultPushTypeAvailableEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.VerificationresultStatusEnumFactory

class VerificationresultStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.VerificationresultValidationProcessEnumFactory

class VerificationresultValidationProcessEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.VerificationresultValidationStatusEnumFactory

class VerificationresultValidationStatusEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.VerificationresultValidationTypeEnumFactory

class VerificationresultValidationTypeEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.VersioningPolicyEnumFactory

class VersioningPolicyEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.VisionBaseCodesEnumFactory

class VisionBaseCodesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.VisionEyeCodesEnumFactory

class VisionEyeCodesEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.VisionProductEnumFactory

class VisionProductEnumFactory extends Object implements Serializable

Class org.hl7.fhir.r4.model.codesystems.W3cProvenanceActivityTypeEnumFactory

class W3cProvenanceActivityTypeEnumFactory extends Object implements Serializable

Package org.hl7.fhir.r4.terminologies

Exception Class org.hl7.fhir.r4.terminologies.ValueSetExpander.ETooCostly

class ETooCostly extends Exception implements Serializable

Package org.hl7.fhir.r4.utils

Exception Class org.hl7.fhir.r4.utils.EOperationOutcome

class EOperationOutcome extends Exception implements Serializable

serialVersionUID:

8887222532359256131L

Serialized Fields

outcome

OperationOutcome outcome

Class org.hl7.fhir.r4.utils.GraphQLEngine.SearchEdge

class SearchEdge extends Base implements Serializable

Serialized Fields

be

Bundle.BundleEntryComponent be

type

String type

Class org.hl7.fhir.r4.utils.GraphQLEngine.SearchWrapper

class SearchWrapper extends Base implements Serializable

Serialized Fields

bnd

Bundle bnd

map

Map<String,String> map

type

String type

Package org.hl7.fhir.r4.utils.client

Exception Class org.hl7.fhir.r4.utils.client.EFhirClientException

class EFhirClientException extends RuntimeException implements Serializable

serialVersionUID:

1L

Serialized Fields

errors

List<OperationOutcome> errors