Serialized Form
-
Package org.hl7.fhir.dstu3.elementmodel
-
Class org.hl7.fhir.dstu3.elementmodel.Element
class Element extends Base implements Serializable-
Serialized Fields
-
children
List<Element> children
-
col
int col
-
comments
List<String> comments
-
elementProperty
Property elementProperty
-
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.dstu3.fhirpath
-
Exception Class org.hl7.fhir.dstu3.fhirpath.FHIRLexer.FHIRLexerException
class FHIRLexerException extends org.hl7.fhir.exceptions.FHIRException implements Serializable
-
-
Package org.hl7.fhir.dstu3.model
-
Class org.hl7.fhir.dstu3.model.Account
class Account extends DomainResource implements Serializable- serialVersionUID:
- 1653702558L
-
Serialized Fields
-
active
Period active
Indicates the period of time over which the account is allowed to have transactions posted to it. This period may be different to the coveragePeriod which is the duration of time that services may occur. -
balance
Money balance
Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negative. -
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
Parties financially responsible for the account. -
identifier
List<Identifier> identifier
Unique identifier used to reference the account. May or may 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 organization, department, etc. with responsibility for the account. -
ownerTarget
Organization ownerTarget
The actual object that is the target of the reference (Indicates the organization, department, etc. with responsibility for the account.) -
period
Period period
Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc. -
status
Enumeration<Account.AccountStatus> status
Indicates whether the account is presently used/usable or not. -
subject
Reference subject
Identifies the patient, device, practitioner, location or other object the account is associated with. -
subjectTarget
Resource subjectTarget
The actual object that is the target of the reference (Identifies the patient, device, practitioner, location or other object the account is associated with.) -
type
CodeableConcept type
Categorizes the account for reporting and searching purposes.
-
-
Class org.hl7.fhir.dstu3.model.Account.AccountStatusEnumFactory
class AccountStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Account.CoverageComponent
class CoverageComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1046265008L
-
Serialized Fields
-
coverage
Reference coverage
The party(s) that are responsible for payment (or part of) of charges applied to this account (including self-pay). A coverage may only be resposible 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 are responsible for payment (or part of) of charges applied to this account (including self-pay). A coverage may only be resposible 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.dstu3.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.dstu3.model.ActivityDefinition
class ActivityDefinition extends MetadataResource implements Serializable- serialVersionUID:
- 1741931476L
-
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. -
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. -
contributor
List<Contributor> contributor
A contributor to the content of the asset, including authors, editors, reviewers, and endorsers. -
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. -
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 intent resource that would contain the result. -
effectivePeriod
Period effectivePeriod
The period during which the activity definition content was or is planned to be in active use. -
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. -
kind
Enumeration<ActivityDefinition.ActivityDefinitionKind> kind
A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ProcedureRequest, 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 doesn't change the original approval date. -
library
List<Reference> library
A reference to a Library resource containing any formal logic used by the asset. -
libraryTarget
List<Library> libraryTarget
The actual objects that are the target of the reference (A reference to a Library resource containing any formal logic used by the asset.) -
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.) -
participant
List<ActivityDefinition.ActivityDefinitionParticipantComponent> participant
Indicates who should participate in performing the action described. -
product
Type product
Identifies the food, drug or other product being consumed or supplied in the activity. -
purpose
MarkdownType purpose
Explaination of why this activity definition is needed and why it has been designed as it has. -
quantity
SimpleQuantity 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. -
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
Reference 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. -
transformTarget
StructureMap transformTarget
The actual object that is the target of the reference (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 asset is used from a clinical perspective.
-
-
Class org.hl7.fhir.dstu3.model.ActivityDefinition.ActivityDefinitionDynamicValueComponent
class ActivityDefinitionDynamicValueComponent extends BackboneElement implements Serializable- serialVersionUID:
- 448404361L
-
Serialized Fields
-
description
StringType description
A brief, natural language description of the intended semantics of the dynamic value. -
expression
StringType expression
An expression specifying the value of the customized element. -
language
StringType language
The media type of the language for the expression. -
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.
-
-
Class org.hl7.fhir.dstu3.model.ActivityDefinition.ActivityDefinitionKindEnumFactory
class ActivityDefinitionKindEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.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.dstu3.model.ActivityDefinition.ActivityParticipantTypeEnumFactory
class ActivityParticipantTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Address
class Address extends Type implements Serializable- serialVersionUID:
- 561490318L
-
Serialized Fields
-
city
StringType city
The name of the city, town, 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 (i.e. US 2 letter state codes). -
text
StringType text
A full text representation of the address. -
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.dstu3.model.Address.AddressTypeEnumFactory
class AddressTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Address.AddressUseEnumFactory
class AddressUseEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.AdverseEvent
class AdverseEvent extends DomainResource implements Serializable- serialVersionUID:
- 156251238L
-
Serialized Fields
-
category
Enumeration<AdverseEvent.AdverseEventCategory> category
The type of event which is important to characterize what occurred and caused harm to the subject, or had the potential to cause harm to the subject. -
date
DateTimeType date
The date (and perhaps time) when the adverse event occurred. -
description
StringType description
Describes the adverse event in text. -
eventParticipant
Reference eventParticipant
Parties that may or should contribute or have contributed information to the Act. Such information includes information leading to the decision to perform the Act and how to perform the Act (e.g. consultant), information that the Act itself seeks to reveal (e.g. informant of clinical history), or information about what Act was performed (e.g. informant witness). -
eventParticipantTarget
Resource eventParticipantTarget
The actual object that is the target of the reference (Parties that may or should contribute or have contributed information to the Act. Such information includes information leading to the decision to perform the Act and how to perform the Act (e.g. consultant), information that the Act itself seeks to reveal (e.g. informant of clinical history), or information about what Act was performed (e.g. informant witness).) -
identifier
Identifier identifier
The identifier(s) of this adverse event that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itsefl is not appropriate. -
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. -
reaction
List<Reference> reaction
Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical). -
reactionTarget
List<Condition> reactionTarget
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).) -
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.) -
seriousness
CodeableConcept seriousness
Describes the seriousness or severity of the adverse event. -
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. With a prospective adverse event, there will be no subject as the adverse event was prevented. -
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. With a prospective adverse event, there will be no subject as the adverse event was prevented.) -
suspectEntity
List<AdverseEvent.AdverseEventSuspectEntityComponent> suspectEntity
Describes the entity that is suspected to have caused the adverse event. -
type
CodeableConcept type
This element defines the specific type of event that occurred or that was prevented from occurring.
-
-
Class org.hl7.fhir.dstu3.model.AdverseEvent.AdverseEventCategoryEnumFactory
class AdverseEventCategoryEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.AdverseEvent.AdverseEventCausalityEnumFactory
class AdverseEventCausalityEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.AdverseEvent.AdverseEventSuspectEntityComponent
class AdverseEventSuspectEntityComponent extends BackboneElement implements Serializable- serialVersionUID:
- -815429592L
-
Serialized Fields
-
causality
Enumeration<AdverseEvent.AdverseEventCausality> causality
causality1 | causality2. -
causalityAssessment
CodeableConcept causalityAssessment
assess1 | assess2. -
causalityAuthor
Reference causalityAuthor
AdverseEvent.suspectEntity.causalityAuthor. -
causalityAuthorTarget
Resource causalityAuthorTarget
The actual object that is the target of the reference (AdverseEvent.suspectEntity.causalityAuthor.) -
causalityMethod
CodeableConcept causalityMethod
method1 | method2. -
causalityProductRelatedness
StringType causalityProductRelatedness
AdverseEvent.suspectEntity.causalityProductRelatedness. -
causalityResult
CodeableConcept causalityResult
result1 | result2. -
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.dstu3.model.Age
class Age extends Quantity implements Serializable- serialVersionUID:
- 0L
-
Class org.hl7.fhir.dstu3.model.AllergyIntolerance
class AllergyIntolerance extends DomainResource implements Serializable- serialVersionUID:
- 948924623L
-
Serialized Fields
-
assertedDate
DateTimeType assertedDate
The date on which the existance of the AllergyIntolerance was first asserted or acknowledged. -
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
Enumeration<AllergyIntolerance.AllergyIntoleranceClinicalStatus> 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"). -
criticality
Enumeration<AllergyIntolerance.AllergyIntoleranceCriticality> criticality
Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance. -
identifier
List<Identifier> identifier
This records identifiers associated with this allergy/intolerance 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). -
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. -
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
Enumeration<AllergyIntolerance.AllergyIntoleranceVerificationStatus> 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.dstu3.model.AllergyIntolerance.AllergyIntoleranceCategoryEnumFactory
class AllergyIntoleranceCategoryEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.AllergyIntolerance.AllergyIntoleranceClinicalStatusEnumFactory
class AllergyIntoleranceClinicalStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.AllergyIntolerance.AllergyIntoleranceCriticalityEnumFactory
class AllergyIntoleranceCriticalityEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.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'.
-
-
Class org.hl7.fhir.dstu3.model.AllergyIntolerance.AllergyIntoleranceSeverityEnumFactory
class AllergyIntoleranceSeverityEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.AllergyIntolerance.AllergyIntoleranceTypeEnumFactory
class AllergyIntoleranceTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.AllergyIntolerance.AllergyIntoleranceVerificationStatusEnumFactory
class AllergyIntoleranceVerificationStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Annotation
class Annotation extends Type implements Serializable- serialVersionUID:
- -575590381L
-
Serialized Fields
-
author
Type author
The individual responsible for making the annotation. -
text
StringType text
The text of the annotation. -
time
DateTimeType time
Indicates when this particular annotation was made.
-
-
Class org.hl7.fhir.dstu3.model.Appointment
class Appointment extends DomainResource implements Serializable- serialVersionUID:
- -1589372810L
-
Serialized Fields
-
appointmentType
CodeableConcept appointmentType
The style of appointment or patient that has been booked in the slot (not service type). -
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). -
incomingReferral
List<Reference> incomingReferral
The referral request this appointment is allocated to assess (incoming referral). -
incomingReferralTarget
List<ReferralRequest> incomingReferralTarget
The actual objects that are the target of the reference (The referral request this appointment is allocated to assess (incoming referral).) -
indication
List<Reference> indication
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. -
indicationTarget
List<Resource> indicationTarget
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.) -
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 (where actual time of appointment is only an estimate or is a planned appointment request). -
participant
List<Appointment.AppointmentParticipantComponent> participant
List of participants involved in the appointment. -
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). -
reason
List<CodeableConcept> reason
The reason that this appointment is being scheduled. This is more clinical than administrative. -
requestedPeriod
List<Period> requestedPeriod
A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. When using these values, the minutes duration should be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. -
serviceCategory
CodeableConcept serviceCategory
A broad categorisation 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.dstu3.model.Appointment.AppointmentParticipantComponent
class AppointmentParticipantComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1620552507L
-
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.) -
required
Enumeration<Appointment.ParticipantRequired> required
Is this participant required to be present at the meeting. This covers a use-case where 2 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.dstu3.model.Appointment.AppointmentStatusEnumFactory
class AppointmentStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Appointment.ParticipantRequiredEnumFactory
class ParticipantRequiredEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Appointment.ParticipationStatusEnumFactory
class ParticipationStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.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.dstu3.model.AppointmentResponse.ParticipantStatusEnumFactory
class ParticipantStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Attachment
class Attachment extends Type implements Serializable- serialVersionUID:
- 581007080L
-
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. In XML, represented using base64. -
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
UriType url
An alternative location where the data can be accessed.
-
-
Class org.hl7.fhir.dstu3.model.AuditEvent
class AuditEvent extends DomainResource implements Serializable- serialVersionUID:
- 2102955199L
-
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. -
purposeOfEvent
List<CodeableConcept> purposeOfEvent
The purposeOfUse (reason) that was used during the event being recorded. -
recorded
InstantType recorded
The time when the event occurred on the source. -
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.dstu3.model.AuditEvent.AuditEventActionEnumFactory
class AuditEventActionEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.AuditEvent.AuditEventAgentComponent
class AuditEventAgentComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1205071410L
-
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. -
reference
Reference reference
Direct reference to a resource that identifies the agent. -
referenceTarget
Resource referenceTarget
The actual object that is the target of the reference (Direct reference to a resource that identifies the agent.) -
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. -
userId
Identifier userId
Unique identifier for the user actively participating in the event.
-
-
Class org.hl7.fhir.dstu3.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.dstu3.model.AuditEvent.AuditEventAgentNetworkTypeEnumFactory
class AuditEventAgentNetworkTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.AuditEvent.AuditEventEntityComponent
class AuditEventEntityComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1393424632L
-
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. -
identifier
Identifier identifier
Identifies a specific instance of the entity. The reference should always be version specific. -
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. -
reference
Reference reference
Identifies a specific instance of the entity. The reference should be version specific. -
referenceTarget
Resource referenceTarget
The actual object that is the target of the reference (Identifies a specific instance of the entity. The reference should be version specific.) -
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.
-
-
Class org.hl7.fhir.dstu3.model.AuditEvent.AuditEventEntityDetailComponent
class AuditEventEntityDetailComponent extends BackboneElement implements Serializable- serialVersionUID:
- 11139504L
-
Serialized Fields
-
type
StringType type
The type of extra detail provided in the value. -
value
Base64BinaryType value
The details, base64 encoded. Used to carry bulk information.
-
-
Class org.hl7.fhir.dstu3.model.AuditEvent.AuditEventOutcomeEnumFactory
class AuditEventOutcomeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.AuditEvent.AuditEventSourceComponent
class AuditEventSourceComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1562673890L
-
Serialized Fields
-
identifier
Identifier identifier
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.dstu3.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 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.dstu3.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.dstu3.model.Base64BinaryType
class Base64BinaryType extends PrimitiveType<byte[]> implements Externalizable- serialVersionUID:
- 3L
-
Serialization Methods
-
readExternal
- Throws:
IOException
ClassNotFoundException
-
writeExternal
- Throws:
IOException
-
-
Class org.hl7.fhir.dstu3.model.BaseBinary
class BaseBinary extends Resource implements Serializable- serialVersionUID:
- 1L
-
Class org.hl7.fhir.dstu3.model.BaseDateTimeType
- serialVersionUID:
- 1L
-
Serialization Methods
-
readExternal
- Throws:
IOException
ClassNotFoundException
-
writeExternal
- Throws:
IOException
-
-
Class org.hl7.fhir.dstu3.model.BaseExtension
class BaseExtension extends Type implements Serializable- serialVersionUID:
- 1L
-
Class org.hl7.fhir.dstu3.model.BaseNarrative
class BaseNarrative extends Type implements Serializable -
Class org.hl7.fhir.dstu3.model.BaseReference
class BaseReference extends Type implements Serializable -
Class org.hl7.fhir.dstu3.model.BaseResource
class BaseResource extends Base implements Serializable- serialVersionUID:
- 1L
-
Class org.hl7.fhir.dstu3.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.dstu3.model.Binary
class Binary extends BaseBinary implements Serializable- serialVersionUID:
- 1111991335L
-
Serialized Fields
-
content
Base64BinaryType content
The actual content, base64 encoded. -
contentType
CodeType contentType
MimeType of the binary content represented as a standard MimeType (BCP 13). -
securityContext
Reference securityContext
Treat this binary as if it was this other resource for access control purposes. -
securityContextTarget
Resource securityContextTarget
The actual object that is the target of the reference (Treat this binary as if it was this other resource for access control purposes.)
-
-
Class org.hl7.fhir.dstu3.model.BodySite
class BodySite extends DomainResource implements Serializable- serialVersionUID:
- -871837171L
-
Serialized Fields
-
active
BooleanType active
Whether this body site is in active use. -
code
CodeableConcept code
Named anatomical location - ideally coded where possible. -
description
StringType description
A summary, charactarization or explanation of the anatomic location. -
identifier
List<Identifier> identifier
Identifier for this instance of the anatomical location. -
image
List<Attachment> image
Image or images used to identify a location. -
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.) -
qualifier
List<CodeableConcept> qualifier
Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.
-
-
Class org.hl7.fhir.dstu3.model.BooleanType
- serialVersionUID:
- 3L
-
Serialization Methods
-
readExternal
- Throws:
IOException
ClassNotFoundException
-
writeExternal
- Throws:
IOException
-
-
Class org.hl7.fhir.dstu3.model.Bundle
class Bundle extends Resource implements Serializable- serialVersionUID:
- 982760501L
-
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 batch that won't change as a batch 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. -
total
UnsignedIntType total
If a set of search matches, this is the total number of matches for the search (as opposed to the number of results in this bundle). -
type
Enumeration<Bundle.BundleType> type
Indicates the purpose of this bundle - how it was intended to be used.
-
-
Class org.hl7.fhir.dstu3.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. 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. -
resource
Resource resource
The Resources for the entry. -
response
Bundle.BundleEntryResponseComponent response
Additional information about how this entry should be processed as part of a transaction. -
search
Bundle.BundleEntrySearchComponent search
Information about the search process that lead to the creation of this entry.
-
-
Class org.hl7.fhir.dstu3.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
The HTTP verb for this entry in either a change history, or a transaction/ transaction response. -
url
UriType url
The URL for this entry, relative to the root (the address to which the request is posted).
-
-
Class org.hl7.fhir.dstu3.model.Bundle.BundleEntryResponseComponent
class BundleEntryResponseComponent extends BackboneElement implements Serializable- serialVersionUID:
- 923278008L
-
Serialized Fields
-
etag
StringType etag
The etag for the resource, it 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. -
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.dstu3.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. -
score
DecimalType score
When searching, the server's search ranking score for the entry.
-
-
Class org.hl7.fhir.dstu3.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.dstu3.model.Bundle.BundleTypeEnumFactory
class BundleTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Bundle.HTTPVerbEnumFactory
class HTTPVerbEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Bundle.SearchEntryModeEnumFactory
class SearchEntryModeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.CapabilityStatement
class CapabilityStatement extends MetadataResource implements Serializable- serialVersionUID:
- 227177541L
-
Serialized Fields
-
acceptUnknown
Enumeration<CapabilityStatement.UnknownContentCode> acceptUnknown
A code that indicates whether the application accepts unknown elements or extensions when reading resources. -
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
IdType fhirVersion
The version of the FHIR specification on which this capability statement is based. -
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<UriType> implementationGuide
A list of implementation guides that the server does (or should) support in their entirety. -
instantiates
List<UriType> instantiates
Reference to a canonical URL of another CapabilityStatement that this software implements or uses. This capability statement is a published API description that corresponds to a business service. The rest of the capability statement does not need to repeat the details of the referenced resource, but can do so. -
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. -
profile
List<Reference> profile
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). -
profileTarget
List<StructureDefinition> profileTarget
The actual objects that are the target of the reference (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).) -
purpose
MarkdownType purpose
Explaination 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.dstu3.model.CapabilityStatement.CapabilityStatementDocumentComponent
class CapabilityStatementDocumentComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1059555053L
-
Serialized Fields
-
documentation
StringType 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
Reference profile
A constraint on a resource used in the document. -
profileTarget
StructureDefinition profileTarget
The actual object that is the target of the reference (A constraint on a resource used in the document.)
-
-
Class org.hl7.fhir.dstu3.model.CapabilityStatement.CapabilityStatementImplementationComponent
class CapabilityStatementImplementationComponent extends BackboneElement implements Serializable- serialVersionUID:
- -289238508L
-
Serialized Fields
-
description
StringType description
Information about the specific installation that this capability statement relates to. -
url
UriType 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.dstu3.model.CapabilityStatement.CapabilityStatementKindEnumFactory
class CapabilityStatementKindEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.CapabilityStatement.CapabilityStatementMessagingComponent
class CapabilityStatementMessagingComponent extends BackboneElement implements Serializable- serialVersionUID:
- 816243355L
-
Serialized Fields
-
documentation
StringType 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. -
event
List<CapabilityStatement.CapabilityStatementMessagingEventComponent> event
A description of the solution's support for an event at this end-point. -
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.dstu3.model.CapabilityStatement.CapabilityStatementMessagingEndpointComponent
class CapabilityStatementMessagingEndpointComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1294656428L
-
Class org.hl7.fhir.dstu3.model.CapabilityStatement.CapabilityStatementMessagingEventComponent
class CapabilityStatementMessagingEventComponent extends BackboneElement implements Serializable- serialVersionUID:
- -491306017L
-
Serialized Fields
-
category
Enumeration<CapabilityStatement.MessageSignificanceCategory> category
The impact of the content of the message. -
code
Coding code
A coded identifier of a supported messaging event. -
documentation
StringType documentation
Guidance on how this event is handled, such as internal system trigger points, business rules, etc. -
focus
CodeType focus
A resource associated with the event. This is the resource that defines the event. -
mode
Enumeration<CapabilityStatement.EventCapabilityMode> mode
The mode of this event declaration - whether an application is a sender or receiver. -
request
Reference request
Information about the request for this event. -
requestTarget
StructureDefinition requestTarget
The actual object that is the target of the reference (Information about the request for this event.) -
response
Reference response
Information about the response for this event. -
responseTarget
StructureDefinition responseTarget
The actual object that is the target of the reference (Information about the response for this event.)
-
-
Class org.hl7.fhir.dstu3.model.CapabilityStatement.CapabilityStatementMessagingSupportedMessageComponent
class CapabilityStatementMessagingSupportedMessageComponent extends BackboneElement implements Serializable- serialVersionUID:
- -741523869L
-
Serialized Fields
-
definition
Reference definition
Points to a message definition that identifies the messaging event, message structure, allowed responses, etc. -
definitionTarget
MessageDefinition definitionTarget
The actual object that is the target of the reference (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.dstu3.model.CapabilityStatement.CapabilityStatementRestComponent
class CapabilityStatementRestComponent extends BackboneElement implements Serializable- serialVersionUID:
- 38012979L
-
Serialized Fields
-
compartment
List<UriType> 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
StringType 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.CapabilityStatementRestOperationComponent> 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.dstu3.model.CapabilityStatement.CapabilityStatementRestOperationComponent
class CapabilityStatementRestOperationComponent extends BackboneElement implements Serializable- serialVersionUID:
- 122107272L
-
Serialized Fields
-
definition
Reference definition
Where the formal definition can be found. -
definitionTarget
OperationDefinition definitionTarget
The actual object that is the target of the reference (Where the formal definition can be found.) -
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.dstu3.model.CapabilityStatement.CapabilityStatementRestResourceComponent
class CapabilityStatementRestResourceComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1271233297L
-
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. -
profile
Reference 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). -
profileTarget
StructureDefinition profileTarget
The actual object that is the target of the reference (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. -
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 (e.g. 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.dstu3.model.CapabilityStatement.CapabilityStatementRestResourceSearchParamComponent
class CapabilityStatementRestResourceSearchParamComponent extends BackboneElement implements Serializable- serialVersionUID:
- 72133006L
-
Serialized Fields
-
definition
UriType 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]]]). -
documentation
StringType 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.dstu3.model.CapabilityStatement.CapabilityStatementRestSecurityCertificateComponent
class CapabilityStatementRestSecurityCertificateComponent extends BackboneElement implements Serializable- serialVersionUID:
- 2092655854L
-
Serialized Fields
-
blob
Base64BinaryType blob
Actual certificate. -
type
CodeType type
Mime type for a certificate.
-
-
Class org.hl7.fhir.dstu3.model.CapabilityStatement.CapabilityStatementRestSecurityComponent
class CapabilityStatementRestSecurityComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1081654002L
-
Serialized Fields
-
certificate
List<CapabilityStatement.CapabilityStatementRestSecurityCertificateComponent> certificate
Certificates associated with security profiles. -
cors
BooleanType cors
Server adds CORS headers when responding to requests - this enables javascript applications to use the server. -
description
StringType 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.dstu3.model.CapabilityStatement.CapabilityStatementSoftwareComponent
class CapabilityStatementSoftwareComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1819769027L
-
Serialized Fields
-
name
StringType name
Name 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.dstu3.model.CapabilityStatement.ConditionalDeleteStatusEnumFactory
class ConditionalDeleteStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.CapabilityStatement.ConditionalReadStatusEnumFactory
class ConditionalReadStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.CapabilityStatement.DocumentModeEnumFactory
class DocumentModeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.CapabilityStatement.EventCapabilityModeEnumFactory
class EventCapabilityModeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.CapabilityStatement.MessageSignificanceCategoryEnumFactory
class MessageSignificanceCategoryEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.CapabilityStatement.ReferenceHandlingPolicyEnumFactory
class ReferenceHandlingPolicyEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.CapabilityStatement.ResourceInteractionComponent
class ResourceInteractionComponent extends BackboneElement implements Serializable- serialVersionUID:
- -437507806L
-
Serialized Fields
-
code
Enumeration<CapabilityStatement.TypeRestfulInteraction> code
Coded identifier of the operation, supported by the system resource. -
documentation
StringType 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.dstu3.model.CapabilityStatement.ResourceVersionPolicyEnumFactory
class ResourceVersionPolicyEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.CapabilityStatement.RestfulCapabilityModeEnumFactory
class RestfulCapabilityModeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.CapabilityStatement.SystemInteractionComponent
class SystemInteractionComponent extends BackboneElement implements Serializable- serialVersionUID:
- 510675287L
-
Serialized Fields
-
code
Enumeration<CapabilityStatement.SystemRestfulInteraction> code
A coded identifier of the operation, supported by the system. -
documentation
StringType 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.dstu3.model.CapabilityStatement.SystemRestfulInteractionEnumFactory
class SystemRestfulInteractionEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.CapabilityStatement.TypeRestfulInteractionEnumFactory
class TypeRestfulInteractionEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.CapabilityStatement.UnknownContentCodeEnumFactory
class UnknownContentCodeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.CarePlan
class CarePlan extends DomainResource implements Serializable- serialVersionUID:
- 995943625L
-
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
List<Reference> author
Identifies the individual(s) or ogranization who is responsible for the content of the care plan. -
authorTarget
List<Resource> authorTarget
The actual objects that are the target of the reference (Identifies the individual(s) or ogranization who is responsible for the content of the care plan.) -
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. -
context
Reference context
Identifies the original context in which this particular CarePlan was created. -
contextTarget
Resource contextTarget
The actual object that is the target of the reference (Identifies the original context in which this particular CarePlan was created.) -
definition
List<Reference> definition
Identifies the protocol, questionnaire, guideline or other specification the care plan should be conducted in accordance with. -
definitionTarget
List<Resource> definitionTarget
The actual objects that are the target of the reference (Identifies the protocol, questionnaire, guideline or other specification the care plan should be conducted in accordance with.) -
description
StringType description
A description of the scope and nature of the plan. -
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
This records identifiers associated with this care plan 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). -
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 co-morbidities, 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 co-morbidities, recent procedures, limitations, recent assessments, etc.) -
title
StringType title
Human-friendly name for the CarePlan.
-
-
Class org.hl7.fhir.dstu3.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.dstu3.model.CarePlan.CarePlanActivityDetailComponent
class CarePlanActivityDetailComponent extends BackboneElement implements Serializable- serialVersionUID:
- -549984462L
-
Serialized Fields
-
category
CodeableConcept category
High-level categorization of the type of activity in a care plan. -
code
CodeableConcept code
Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter. -
dailyAmount
SimpleQuantity dailyAmount
Identifies the quantity expected to be consumed in a given day. -
definition
Reference definition
Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with. -
definitionTarget
Resource definitionTarget
The actual object that is the target of the reference (Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.) -
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. -
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.) -
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. -
prohibited
BooleanType prohibited
If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, indicates that the described activity is one that should be engaged in when following the plan. -
quantity
SimpleQuantity 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
Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan. -
reasonReferenceTarget
List<Condition> reasonReferenceTarget
The actual objects that are the target of the reference (Provides the health condition(s) that 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
StringType statusReason
Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.
-
-
Class org.hl7.fhir.dstu3.model.CarePlan.CarePlanActivityStatusEnumFactory
class CarePlanActivityStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.CarePlan.CarePlanIntentEnumFactory
class CarePlanIntentEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.CarePlan.CarePlanStatusEnumFactory
class CarePlanStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.CareTeam
class CareTeam extends DomainResource implements Serializable- serialVersionUID:
- 1568354370L
-
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. -
context
Reference context
The encounter or episode of care that establishes the context for this care team. -
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 care team.) -
identifier
List<Identifier> identifier
This records identifiers associated with this care team 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. -
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.)
-
-
Class org.hl7.fhir.dstu3.model.CareTeam.CareTeamParticipantComponent
class CareTeamParticipantComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1363308804L
-
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
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.dstu3.model.CareTeam.CareTeamStatusEnumFactory
class CareTeamStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.ChargeItem
class ChargeItem extends DomainResource implements Serializable- serialVersionUID:
- 1421123938L
-
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.) -
definition
List<UriType> definition
References the 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
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. -
participant
List<ChargeItem.ChargeItemParticipantComponent> participant
Indicates who or what performed or participated in the charged service. -
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.) -
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. -
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 the this charge. -
supportingInformationTarget
List<Resource> supportingInformationTarget
The actual objects that are the target of the reference (Further information supporting the this charge.)
-
-
Class org.hl7.fhir.dstu3.model.ChargeItem.ChargeItemParticipantComponent
class ChargeItemParticipantComponent 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 performance or participation(e.g. primary surgeon, anaesthesiologiest, etc.).
-
-
Class org.hl7.fhir.dstu3.model.ChargeItem.ChargeItemStatusEnumFactory
class ChargeItemStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Claim
class Claim extends DomainResource implements Serializable- serialVersionUID:
- 1731171342L
-
Serialized Fields
-
accident
Claim.AccidentComponent accident
An accident which resulted in the need for healthcare services. -
billablePeriod
Period billablePeriod
The billable period for which charges are being submitted. -
careTeam
List<Claim.CareTeamComponent> careTeam
The members of the team who provided the overall service as well as their role and whether responsible and qualifications. -
created
DateTimeType created
The date when the enclosed suite of services were performed or completed. -
diagnosis
List<Claim.DiagnosisComponent> diagnosis
List of patient diagnosis for which care is sought. -
employmentImpacted
Period employmentImpacted
The start and optional end dates of when the patient was precluded from working due to the treatable condition(s). -
enterer
Reference enterer
Person who created the invoice/claim/pre-determination or pre-authorization. -
entererTarget
Practitioner entererTarget
The actual object that is the target of the reference (Person who created the invoice/claim/pre-determination or pre-authorization.) -
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
In the case of a Pre-Determination/Pre-Authorization the provider may request that funds in the amount of the expected Benefit be reserved ('Patient' or 'Provider') to pay for the Benefits determined on the subsequent claim(s). 'None' explicitly indicates no funds reserving is requested. -
hospitalization
Period hospitalization
The start and optional end dates of when the patient was confined to a treatment center. -
identifier
List<Identifier> identifier
The business identifier for the instance: claim number, pre-determination or pre-authorization number. -
information
List<Claim.SpecialConditionComponent> information
Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. Often there are mutiple jurisdiction specific valuesets which are required. -
insurance
List<Claim.InsuranceComponent> insurance
Financial instrument by which payment information for health care. -
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
First tier of goods and services. -
organization
Reference organization
The organization which is responsible for the bill, claim pre-determination, pre-authorization. -
organizationTarget
Organization organizationTarget
The actual object that is the target of the reference (The organization which is responsible for the bill, claim pre-determination, pre-authorization.) -
originalPrescription
Reference originalPrescription
Original prescription which has been superceded by this prescription to support the dispensing of pharmacy services, medications or products. For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefor issues a new precription for an alternate medication which has the same theraputic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'. -
originalPrescriptionTarget
MedicationRequest originalPrescriptionTarget
The actual object that is the target of the reference (Original prescription which has been superceded by this prescription to support the dispensing of pharmacy services, medications or products. For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefor issues a new precription for an alternate medication which has the same theraputic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'.) -
patient
Reference patient
Patient Resource. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (Patient Resource.) -
payee
Claim.PayeeComponent payee
The party to be reimbursed for the services. -
prescription
Reference prescription
Prescription to support the dispensing of Pharmacy or Vision products. -
prescriptionTarget
Resource prescriptionTarget
The actual object that is the target of the reference (Prescription to support the dispensing of Pharmacy or Vision products.) -
priority
CodeableConcept priority
Immediate (STAT), best effort (NORMAL), deferred (DEFER). -
procedure
List<Claim.ProcedureComponent> procedure
Ordered list of patient procedures performed to support the adjudication. -
provider
Reference provider
The provider which is responsible for the bill, claim pre-determination, pre-authorization. -
providerTarget
Practitioner providerTarget
The actual object that is the target of the reference (The provider which is responsible for the bill, claim pre-determination, pre-authorization.) -
referral
Reference referral
The referral resource which lists the date, practitioner, reason and other supporting information. -
referralTarget
ReferralRequest referralTarget
The actual object that is the target of the reference (The referral resource which lists the date, practitioner, reason and other supporting information.) -
related
List<Claim.RelatedClaimComponent> related
Other claims which are related to this claim such as prior claim versions or for related services. -
status
Enumeration<Claim.ClaimStatus> status
The status of the resource instance. -
subType
List<CodeableConcept> subType
A finer grained suite of claim subtype codes which may convey Inpatient vs Outpatient and/or a specialty service. In the US the BillType. -
total
Money total
The total value of the claim. -
type
CodeableConcept type
The category of claim, eg, oral, pharmacy, vision, insitutional, professional. -
use
Enumeration<Claim.Use> use
Complete (Bill or Claim), Proposed (Pre-Authorization), Exploratory (Pre-determination).
-
-
Class org.hl7.fhir.dstu3.model.Claim.AccidentComponent
class AccidentComponent extends BackboneElement implements Serializable- serialVersionUID:
- 622904984L
-
Serialized Fields
-
date
DateType date
Date of an accident which these services are addressing. -
location
Type location
Accident Place. -
type
CodeableConcept type
Type of accident: work, auto, etc.
-
-
Class org.hl7.fhir.dstu3.model.Claim.CareTeamComponent
class CareTeamComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1758966968L
-
Serialized Fields
-
provider
Reference provider
Member of the team who provided the overall service. -
providerTarget
Resource providerTarget
The actual object that is the target of the reference (Member of the team who provided the overall service.) -
qualification
CodeableConcept qualification
The qualification which is applicable for this service. -
responsible
BooleanType responsible
The party who is billing and responsible for the claimed good or service rendered to the patient. -
role
CodeableConcept role
The lead, assisting or supervising practitioner and their discipline if a multidisiplinary team. -
sequence
PositiveIntType sequence
Sequence of the careTeam which serves to order and provide a link.
-
-
Class org.hl7.fhir.dstu3.model.Claim.ClaimStatusEnumFactory
class ClaimStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Claim.DetailComponent
class DetailComponent extends BackboneElement implements Serializable- serialVersionUID:
- 718584656L
-
Serialized Fields
-
category
CodeableConcept category
Health Care Service Type Codes to identify the classification of service or benefits. -
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, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours. -
net
Money net
The quantity times the unit price for an addittional service or product or charge. 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. -
programCode
List<CodeableConcept> programCode
For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program. -
quantity
SimpleQuantity quantity
The number of repetitions of a service or product. -
revenue
CodeableConcept revenue
The type of reveneu or cost center providing the product and/or service. -
sequence
PositiveIntType sequence
A service line number. -
service
CodeableConcept service
If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. 'glasses' or 'compound'. -
subDetail
List<Claim.SubDetailComponent> subDetail
Third tier of goods and services. -
udi
List<Reference> udi
List of Unique Device Identifiers associated with this line item. -
udiTarget
List<Device> udiTarget
The actual objects that are the target of the reference (List of Unique Device Identifiers associated with this line item.) -
unitPrice
Money unitPrice
If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.
-
-
Class org.hl7.fhir.dstu3.model.Claim.DiagnosisComponent
class DiagnosisComponent extends BackboneElement implements Serializable- serialVersionUID:
- -350960873L
-
Serialized Fields
-
diagnosis
Type diagnosis
The diagnosis. -
packageCode
CodeableConcept packageCode
The package billing code, for example DRG, based on the assigned grouping code system. -
sequence
PositiveIntType sequence
Sequence of diagnosis which serves to provide a link. -
type
List<CodeableConcept> type
The type of the Diagnosis, for example: admitting, primary, secondary, discharge.
-
-
Class org.hl7.fhir.dstu3.model.Claim.InsuranceComponent
class InsuranceComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1216535489L
-
Serialized Fields
-
businessArrangement
StringType businessArrangement
The contract number of a business agreement which describes the terms and conditions. -
claimResponse
Reference claimResponse
The Coverages adjudication details. -
claimResponseTarget
ClaimResponse claimResponseTarget
The actual object that is the target of the reference (The Coverages adjudication details.) -
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.) -
focal
BooleanType focal
A flag to indicate that this Coverage is the focus for adjudication. The Coverage against which the claim is to be adjudicated. -
preAuthRef
List<StringType> preAuthRef
A list of references from the Insurer to which these services pertain. -
sequence
PositiveIntType sequence
Sequence of coverage which serves to provide a link and convey coordination of benefit order.
-
-
Class org.hl7.fhir.dstu3.model.Claim.ItemComponent
class ItemComponent extends BackboneElement implements Serializable- serialVersionUID:
- 784765825L
-
Serialized Fields
-
bodySite
CodeableConcept bodySite
Physical service site on the patient (limb, tooth, etc). -
careTeamLinkId
List<PositiveIntType> careTeamLinkId
CareTeam applicable for this service or product line. -
category
CodeableConcept category
Health Care Service Type Codes to identify the classification of service or benefits. -
detail
List<Claim.DetailComponent> detail
Second tier of goods and services. -
diagnosisLinkId
List<PositiveIntType> diagnosisLinkId
Diagnosis applicable for this service or product line. -
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. -
informationLinkId
List<PositiveIntType> informationLinkId
Exceptions, special conditions and supporting information pplicable for this service or product line. -
location
Type location
Where the service was provided. -
modifier
List<CodeableConcept> modifier
Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours. -
net
Money net
The quantity times the unit price for an addittional service or product or charge. 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. -
procedureLinkId
List<PositiveIntType> procedureLinkId
Procedures applicable for this service or product line. -
programCode
List<CodeableConcept> programCode
For programs which require reason codes for the inclusion or covering of this billed item under the program or sub-program. -
quantity
SimpleQuantity quantity
The number of repetitions of a service or product. -
revenue
CodeableConcept revenue
The type of reveneu or cost center providing the product and/or service. -
sequence
PositiveIntType sequence
A service line number. -
service
CodeableConcept service
If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,RXNorm,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. 'glasses' or 'compound'. -
serviced
Type serviced
The date or dates when the enclosed suite of services were performed or completed. -
subSite
List<CodeableConcept> subSite
A region or surface of the site, eg. limb region or tooth surface(s). -
udi
List<Reference> udi
List of Unique Device Identifiers associated with this line item. -
udiTarget
List<Device> udiTarget
The actual objects that are the target of the reference (List of Unique Device Identifiers associated with this line item.) -
unitPrice
Money unitPrice
If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.
-
-
Class org.hl7.fhir.dstu3.model.Claim.PayeeComponent
class PayeeComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1395150769L
-
Serialized Fields
-
party
Reference party
Party to be reimbursed: Subscriber, provider, other. -
partyTarget
Resource partyTarget
The actual object that is the target of the reference (Party to be reimbursed: Subscriber, provider, other.) -
resourceType
Coding resourceType
organization | patient | practitioner | relatedperson. -
type
CodeableConcept type
Type of Party to be reimbursed: Subscriber, provider, other.
-
-
Class org.hl7.fhir.dstu3.model.Claim.ProcedureComponent
class ProcedureComponent extends BackboneElement implements Serializable- serialVersionUID:
- 864307347L
-
Serialized Fields
-
date
DateTimeType date
Date and optionally time the procedure was performed . -
procedure
Type procedure
The procedure code. -
sequence
PositiveIntType sequence
Sequence of procedures which serves to order and provide a link.
-
-
Class org.hl7.fhir.dstu3.model.Claim.RelatedClaimComponent
class RelatedClaimComponent extends BackboneElement implements Serializable- serialVersionUID:
- -379338905L
-
Serialized Fields
-
claim
Reference claim
Other claims which are related to this claim such as prior claim versions or for related services. -
claimTarget
Claim claimTarget
The actual object that is the target of the reference (Other claims which are related to this claim such as prior claim versions or for related services.) -
reference
Identifier reference
An alternate organizational reference to the case or file to which this particular claim pertains - eg Property/Casualy insurer claim # or Workers Compensation case # . -
relationship
CodeableConcept relationship
For example prior or umbrella.
-
-
Class org.hl7.fhir.dstu3.model.Claim.SpecialConditionComponent
class SpecialConditionComponent 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 which may influence the adjudication. -
reason
CodeableConcept reason
For example, provides the reason for: the additional stay, or missing tooth or any other situation where a reason code is required in addition to the content. -
sequence
PositiveIntType sequence
Sequence of the information element which serves to provide a link. -
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.dstu3.model.Claim.SubDetailComponent
class SubDetailComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1210367567L
-
Serialized Fields
-
category
CodeableConcept category
Health Care Service Type Codes to identify the classification of service or benefits. -
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, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours. -
net
Money net
The quantity times the unit price for an addittional service or product or charge. 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. -
programCode
List<CodeableConcept> programCode
For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program. -
quantity
SimpleQuantity quantity
The number of repetitions of a service or product. -
revenue
CodeableConcept revenue
The type of reveneu or cost center providing the product and/or service. -
sequence
PositiveIntType sequence
A service line number. -
service
CodeableConcept service
A code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). -
udi
List<Reference> udi
List of Unique Device Identifiers associated with this line item. -
udiTarget
List<Device> udiTarget
The actual objects that are the target of the reference (List of Unique Device Identifiers associated with this line item.) -
unitPrice
Money unitPrice
The fee for an addittional service or product or charge.
-
-
Class org.hl7.fhir.dstu3.model.Claim.UseEnumFactory
class UseEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.ClaimResponse
class ClaimResponse extends DomainResource implements Serializable- serialVersionUID:
- -488591755L
-
Serialized Fields
-
addItem
List<ClaimResponse.AddedItemComponent> addItem
The first tier service adjudications for payor added services. -
communicationRequest
List<Reference> communicationRequest
Request for additional supporting or authorizing information, such as: documents, images or resources. -
communicationRequestTarget
List<CommunicationRequest> communicationRequestTarget
The actual objects that are the target of the reference (Request for additional supporting or authorizing information, such as: documents, images or resources.) -
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. -
error
List<ClaimResponse.ErrorComponent> error
Mutually exclusive with Services Provided (Item). -
form
CodeableConcept form
The form to be used for printing the content. -
identifier
List<Identifier> identifier
The Response business identifier. -
insurance
List<ClaimResponse.InsuranceComponent> insurance
Financial instrument by which payment information for health care. -
insurer
Reference insurer
The Insurer who produced this adjudicated response. -
insurerTarget
Organization insurerTarget
The actual object that is the target of the reference (The Insurer who produced this adjudicated response.) -
item
List<ClaimResponse.ItemComponent> item
The first tier service adjudications for submitted services. -
outcome
CodeableConcept outcome
Processing outcome errror, partial or complete processing. -
patient
Reference patient
Patient Resource. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (Patient Resource.) -
payeeType
CodeableConcept payeeType
Party to be reimbursed: Subscriber, provider, other. -
payment
ClaimResponse.PaymentComponent payment
Payment details for the claim if the claim has been paid. -
processNote
List<ClaimResponse.NoteComponent> processNote
Note text. -
request
Reference request
Original request resource referrence. -
requestOrganization
Reference requestOrganization
The organization which is responsible for the services rendered to the patient. -
requestOrganizationTarget
Organization requestOrganizationTarget
The actual object that is the target of the reference (The organization which is responsible for the services rendered to the patient.) -
requestProvider
Reference requestProvider
The practitioner who is responsible for the services rendered to the patient. -
requestProviderTarget
Practitioner requestProviderTarget
The actual object that is the target of the reference (The practitioner who is responsible for the services rendered to the patient.) -
requestTarget
Claim requestTarget
The actual object that is the target of the reference (Original request resource referrence.) -
reserved
Coding reserved
Status of funds reservation (For provider, for Patient, None). -
status
Enumeration<ClaimResponse.ClaimResponseStatus> status
The status of the resource instance. -
totalBenefit
Money totalBenefit
Total amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductible). -
totalCost
Money totalCost
The total cost of the services reported. -
unallocDeductable
Money unallocDeductable
The amount of deductible applied which was not allocated to any particular service line.
-
-
Class org.hl7.fhir.dstu3.model.ClaimResponse.AddedItemComponent
class AddedItemComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1969703165L
-
Serialized Fields
-
adjudication
List<ClaimResponse.AdjudicationComponent> adjudication
The adjudications results. -
category
CodeableConcept category
Health Care Service Type Codes to identify the classification of service or benefits. -
detail
List<ClaimResponse.AddedItemsDetailComponent> detail
The second tier service adjudications for payor added services. -
fee
Money fee
The fee charged for the professional service or product.. -
modifier
List<CodeableConcept> modifier
Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours. -
noteNumber
List<PositiveIntType> noteNumber
A list of note references to the notes provided below. -
revenue
CodeableConcept revenue
The type of reveneu or cost center providing the product and/or service. -
sequenceLinkId
List<PositiveIntType> sequenceLinkId
List of input service items which this service line is intended to replace. -
service
CodeableConcept service
A code to indicate the Professional Service or Product supplied.
-
-
Class org.hl7.fhir.dstu3.model.ClaimResponse.AddedItemsDetailComponent
class AddedItemsDetailComponent extends BackboneElement implements Serializable- serialVersionUID:
- -311484980L
-
Serialized Fields
-
adjudication
List<ClaimResponse.AdjudicationComponent> adjudication
The adjudications results. -
category
CodeableConcept category
Health Care Service Type Codes to identify the classification of service or benefits. -
fee
Money fee
The fee charged for the professional service or product.. -
modifier
List<CodeableConcept> modifier
Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours. -
noteNumber
List<PositiveIntType> noteNumber
A list of note references to the notes provided below. -
revenue
CodeableConcept revenue
The type of reveneu or cost center providing the product and/or service. -
service
CodeableConcept service
A code to indicate the Professional Service or Product supplied.
-
-
Class org.hl7.fhir.dstu3.model.ClaimResponse.AdjudicationComponent
class AdjudicationComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1559898786L
-
Serialized Fields
-
amount
Money amount
Monetary amount associated with the code. -
category
CodeableConcept category
Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc. -
reason
CodeableConcept reason
Adjudication reason such as limit reached. -
value
DecimalType value
A non-monetary value for example a percentage. Mutually exclusive to the amount element above.
-
-
Class org.hl7.fhir.dstu3.model.ClaimResponse.ClaimResponseStatusEnumFactory
class ClaimResponseStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.ClaimResponse.ErrorComponent
class ErrorComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1379670472L
-
Serialized Fields
-
code
CodeableConcept code
An error code,from a specified code system, which details why the claim could not be adjudicated. -
detailSequenceLinkId
PositiveIntType detailSequenceLinkId
The sequence number of the addition within the line item submitted which contains the error. This value is omitted when the error is not related to an Addition. -
sequenceLinkId
PositiveIntType sequenceLinkId
The sequence number of the line item submitted which contains the error. This value is omitted when the error is elsewhere. -
subdetailSequenceLinkId
PositiveIntType subdetailSequenceLinkId
The sequence number of the addition within the line item submitted which contains the error. This value is omitted when the error is not related to an Addition.
-
-
Class org.hl7.fhir.dstu3.model.ClaimResponse.InsuranceComponent
class InsuranceComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1216535489L
-
Serialized Fields
-
businessArrangement
StringType businessArrangement
The contract number of a business agreement which describes the terms and conditions. -
claimResponse
Reference claimResponse
The Coverages adjudication details. -
claimResponseTarget
ClaimResponse claimResponseTarget
The actual object that is the target of the reference (The Coverages adjudication details.) -
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.) -
focal
BooleanType focal
The instance number of the Coverage which is the focus for adjudication. The Coverage against which the claim is to be adjudicated. -
preAuthRef
List<StringType> preAuthRef
A list of references from the Insurer to which these services pertain. -
sequence
PositiveIntType sequence
A service line item.
-
-
Class org.hl7.fhir.dstu3.model.ClaimResponse.ItemComponent
class ItemComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1282041398L
-
Serialized Fields
-
adjudication
List<ClaimResponse.AdjudicationComponent> adjudication
The adjudication results. -
detail
List<ClaimResponse.ItemDetailComponent> detail
The second tier service adjudications for submitted services. -
noteNumber
List<PositiveIntType> noteNumber
A list of note references to the notes provided below. -
sequenceLinkId
PositiveIntType sequenceLinkId
A service line number.
-
-
Class org.hl7.fhir.dstu3.model.ClaimResponse.ItemDetailComponent
class ItemDetailComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1245557773L
-
Serialized Fields
-
adjudication
List<ClaimResponse.AdjudicationComponent> adjudication
The adjudications results. -
noteNumber
List<PositiveIntType> noteNumber
A list of note references to the notes provided below. -
sequenceLinkId
PositiveIntType sequenceLinkId
A service line number. -
subDetail
List<ClaimResponse.SubDetailComponent> subDetail
The third tier service adjudications for submitted services.
-
-
Class org.hl7.fhir.dstu3.model.ClaimResponse.NoteComponent
class NoteComponent extends BackboneElement implements Serializable- serialVersionUID:
- -944255449L
-
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. -
number
PositiveIntType number
An integer associated with each note which may be referred to from each service line item. -
text
StringType text
The note text. -
type
CodeableConcept type
The note purpose: Print/Display.
-
-
Class org.hl7.fhir.dstu3.model.ClaimResponse.PaymentComponent
class PaymentComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1539906026L
-
Serialized Fields
-
adjustment
Money adjustment
Adjustment to the payment of this transaction which is not related to adjudication of this transaction. -
adjustmentReason
CodeableConcept adjustmentReason
Reason for the payment adjustment. -
amount
Money amount
Payable less any payment adjustment. -
date
DateType date
Estimated payment data. -
identifier
Identifier identifier
Payment identifier. -
type
CodeableConcept type
Whether this represents partial or complete payment of the claim.
-
-
Class org.hl7.fhir.dstu3.model.ClaimResponse.SubDetailComponent
class SubDetailComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1770463342L
-
Serialized Fields
-
adjudication
List<ClaimResponse.AdjudicationComponent> adjudication
The adjudications results. -
noteNumber
List<PositiveIntType> noteNumber
A list of note references to the notes provided below. -
sequenceLinkId
PositiveIntType sequenceLinkId
A service line number.
-
-
Class org.hl7.fhir.dstu3.model.ClinicalImpression
class ClinicalImpression extends DomainResource implements Serializable- serialVersionUID:
- -1626670747L
-
Serialized Fields
-
action
List<Reference> action
Action taken as part of assessment procedure. -
actionTarget
List<Resource> actionTarget
The actual objects that are the target of the reference (Action taken as part of assessment procedure.) -
assessor
Reference assessor
The clinician performing the assessment. -
assessorTarget
Practitioner 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. -
context
Reference context
The encounter or episode of care this impression was created as part of. -
contextTarget
Resource contextTarget
The actual object that is the target of the reference (The encounter or episode of care this impression was created as part of.) -
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 was it performed, and what patient events/status prompted it. -
effective
Type effective
The point in time or period over which the subject was assessed. -
finding
List<ClinicalImpression.ClinicalImpressionFindingComponent> finding
Specific findings or diagnoses that was considered likely or relevant to ongoing treatment. -
identifier
List<Identifier> identifier
A unique identifier assigned to the clinical impression that remains consistent regardless of what server the impression is stored on. -
investigation
List<ClinicalImpression.ClinicalImpressionInvestigationComponent> investigation
One or more sets of investigations (signs, symptions, etc.). The actual grouping of investigations vary 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 assesment that was conducted bon 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 assesment that was conducted bon 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
This a list of the relevant problems/conditions for a patient. -
problemTarget
List<Resource> problemTarget
The actual objects that are the target of the reference (This 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. -
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.
-
-
Class org.hl7.fhir.dstu3.model.ClinicalImpression.ClinicalImpressionFindingComponent
class ClinicalImpressionFindingComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1690728236L
-
Serialized Fields
-
basis
StringType basis
Which investigations support finding or diagnosis. -
item
Type item
Specific text, code or reference for finding or diagnosis, which may include ruled-out or resolved conditions.
-
-
Class org.hl7.fhir.dstu3.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|nutitirional) 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.dstu3.model.ClinicalImpression.ClinicalImpressionStatusEnumFactory
class ClinicalImpressionStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.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.dstu3.model.CodeSystem
class CodeSystem extends MetadataResource implements Serializable- serialVersionUID:
- -1344546572L
-
Serialized Fields
-
caseSensitive
BooleanType caseSensitive
If code comparison is case sensitive when codes within this system are compared to each other. -
compositional
BooleanType compositional
True If code system defines a post-composition 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 meaning of the hierarchical relationships are. -
content
Enumeration<CodeSystem.CodeSystemContentMode> content
How much of the content of the code system - the concepts and codes it defines - are represented in this resource. -
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 count refers to the number of base (primitive) concepts. -
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. -
identifier
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
Explaination of why this code system is needed and why it has been designed as it has. -
valueSet
UriType valueSet
Canonical URL of value set that contains the entire code system. -
versionNeeded
BooleanType versionNeeded
This flag is used to signify that the code system has not (or does not) maintain the definitions, and a version must be specified when referencing this code system.
-
-
Class org.hl7.fhir.dstu3.model.CodeSystem.CodeSystemContentModeEnumFactory
class CodeSystemContentModeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.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 in the instance. -
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.dstu3.model.CodeSystem.CodeSystemHierarchyMeaningEnumFactory
class CodeSystemHierarchyMeaningEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.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.dstu3.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.dstu3.model.CodeSystem.ConceptPropertyComponent
class ConceptPropertyComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1742812311L
-
Class org.hl7.fhir.dstu3.model.CodeSystem.FilterOperatorEnumFactory
class FilterOperatorEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.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 anotherr 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.dstu3.model.CodeSystem.PropertyTypeEnumFactory
class PropertyTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.CodeType
class CodeType extends StringType implements Externalizable- serialVersionUID:
- 3L
-
Serialization Methods
-
readExternal
- Throws:
IOException
ClassNotFoundException
-
writeExternal
- Throws:
IOException
-
-
Class org.hl7.fhir.dstu3.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 - i.e. 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.dstu3.model.Communication
class Communication extends DomainResource implements Serializable- serialVersionUID:
- -1362735590L
-
Serialized Fields
-
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. -
context
Reference context
The encounter within which the communication was sent. -
contextTarget
Resource contextTarget
The actual object that is the target of the reference (The encounter within which the communication was sent.) -
definition
List<Reference> definition
A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event. -
definitionTarget
List<Resource> definitionTarget
The actual objects that are the target of the reference (A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.) -
identifier
List<Identifier> identifier
Identifiers associated with this Communication 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). -
medium
List<CodeableConcept> medium
A channel that was used for this communication (e.g. email, fax). -
notDone
BooleanType notDone
If true, indicates that the described communication event did not actually occur. -
notDoneReason
CodeableConcept notDoneReason
Describes why the communication event did not occur in coded and/or textual form. -
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. -
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, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or 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, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or 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. -
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
List<Reference> topic
The resources which were responsible for or related to producing this communication. -
topicTarget
List<Resource> topicTarget
The actual objects that are the target of the reference (The resources which were responsible for or related to producing this communication.)
-
-
Class org.hl7.fhir.dstu3.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.dstu3.model.Communication.CommunicationStatusEnumFactory
class CommunicationStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.CommunicationRequest
class CommunicationRequest extends DomainResource implements Serializable- serialVersionUID:
- -722867744L
-
Serialized Fields
-
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. -
context
Reference context
The encounter or episode of care within which the communication request was created. -
contextTarget
Resource contextTarget
The actual object that is the target of the reference (The encounter or episode of care within which the communication request was created.) -
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
A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system. -
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
CommunicationRequest.CommunicationRequestRequesterComponent requester
The individual 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. -
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.) -
topic
List<Reference> topic
The resources which were related to producing this communication request. -
topicTarget
List<Resource> topicTarget
The actual objects that are the target of the reference (The resources which were related to producing this communication request.)
-
-
Class org.hl7.fhir.dstu3.model.CommunicationRequest.CommunicationPriorityEnumFactory
class CommunicationPriorityEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.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.dstu3.model.CommunicationRequest.CommunicationRequestRequesterComponent
class CommunicationRequestRequesterComponent extends BackboneElement implements Serializable- serialVersionUID:
- -71453027L
-
Serialized Fields
-
agent
Reference agent
The device, practitioner, etc. who initiated the request. -
agentTarget
Resource agentTarget
The actual object that is the target of the reference (The device, practitioner, etc. who initiated the request.) -
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.dstu3.model.CommunicationRequest.CommunicationRequestStatusEnumFactory
class CommunicationRequestStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.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
Explaination 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.dstu3.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.dstu3.model.CompartmentDefinition.CompartmentTypeEnumFactory
class CompartmentTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Composition
class Composition extends DomainResource implements Serializable- serialVersionUID:
- -1422555114L
-
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.) -
class_
CodeableConcept class_
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
Logical identifier for the composition, assigned when created. 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.dstu3.model.Composition.CompositionAttestationModeEnumFactory
class CompositionAttestationModeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Composition.CompositionAttesterComponent
class CompositionAttesterComponent extends BackboneElement implements Serializable- serialVersionUID:
- -436604745L
-
Serialized Fields
-
mode
List<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.dstu3.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.dstu3.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.dstu3.model.Composition.CompositionStatusEnumFactory
class CompositionStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Composition.DocumentConfidentialityEnumFactory
class DocumentConfidentialityEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Composition.DocumentRelationshipTypeEnumFactory
class DocumentRelationshipTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Composition.SectionComponent
class SectionComponent extends BackboneElement implements Serializable- serialVersionUID:
- -128426142L
-
Serialized Fields
-
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.) -
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.dstu3.model.Composition.SectionModeEnumFactory
class SectionModeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.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
Explaination of why this concept map is needed and why it has been designed as it has. -
source
Type source
The source value set that specifies the concepts that are being mapped. -
target
Type target
The target value set provides context to 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.dstu3.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 Code System (if the source is a value set that crosses more than one code system). -
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 code system of the target code (if the target is a value set that cross code systems). -
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 match in the mappings in the group.
-
-
Class org.hl7.fhir.dstu3.model.ConceptMap.ConceptMapGroupUnmappedComponent
class ConceptMapGroupUnmappedComponent extends BackboneElement implements Serializable- serialVersionUID:
- -482446774L
-
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 in the group. One of 3 actions is 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
UriType url
The canonical URL of the map to use if this map contains no mapping.
-
-
Class org.hl7.fhir.dstu3.model.ConceptMap.ConceptMapGroupUnmappedModeEnumFactory
class ConceptMapGroupUnmappedModeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.ConceptMap.OtherElementComponent
class OtherElementComponent extends BackboneElement implements Serializable- serialVersionUID:
- 678887659L
-
Serialized Fields
-
code
StringType code
Identity (code or path) or the element/item/ValueSet that the map depends on / refers to. -
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 somwhere that is labeled to correspond with a code system property. -
system
UriType 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).
-
-
Class org.hl7.fhir.dstu3.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.dstu3.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.dstu3.model.Condition
class Condition extends DomainResource implements Serializable- serialVersionUID:
- -585250376L
-
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. -
assertedDate
DateTimeType assertedDate
The date on which the existance of the Condition was first asserted or acknowledged. -
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
Enumeration<Condition.ConditionClinicalStatus> clinicalStatus
The clinical status of the condition. -
code
CodeableConcept code
Identification of the condition, problem or diagnosis. -
context
Reference context
Encounter during which the condition was first asserted. -
contextTarget
Resource contextTarget
The actual object that is the target of the reference (Encounter during which the condition was first asserted.) -
evidence
List<Condition.ConditionEvidenceComponent> evidence
Supporting Evidence / manifestations that are the basis on which this condition is suspected or confirmed. -
identifier
List<Identifier> identifier
This records identifiers associated with this condition 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). -
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. -
severity
CodeableConcept severity
A subjective assessment of the severity of the condition as evaluated by the clinician. -
stage
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
Enumeration<Condition.ConditionVerificationStatus> verificationStatus
The verification status to support the clinical status of the condition.
-
-
Class org.hl7.fhir.dstu3.model.Condition.ConditionClinicalStatusEnumFactory
class ConditionClinicalStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.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.dstu3.model.Condition.ConditionStageComponent
class ConditionStageComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1961530405L
-
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.
-
-
Class org.hl7.fhir.dstu3.model.Condition.ConditionVerificationStatusEnumFactory
class ConditionVerificationStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Consent
class Consent extends DomainResource implements Serializable- serialVersionUID:
- -345946739L
-
Serialized Fields
-
action
List<CodeableConcept> action
Actions controlled by this consent. -
actor
List<Consent.ConsentActorComponent> actor
Who or what is controlled by this consent. Use group to identify a set of actors by some property they share (e.g. 'admitting officers'). -
category
List<CodeableConcept> category
A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements. -
consentingParty
List<Reference> consentingParty
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. -
consentingPartyTarget
List<Resource> consentingPartyTarget
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.) -
data
List<Consent.ConsentDataComponent> data
The resources controlled by this consent, if specific resources are referenced. -
dataPeriod
Period dataPeriod
Clinical or Operational Relevant period of time that bounds the data controlled by this consent. -
dateTime
DateTimeType dateTime
When this Consent was issued / created / indexed. -
except
List<Consent.ExceptComponent> except
An exception to the base policy of this consent. An exception can be an addition or removal of access permissions. -
identifier
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.) -
period
Period period
Relevant time or time-period when this Consent is applicable. -
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
UriType policyRule
A referece to the specific computable policy. -
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 consent. -
securityLabel
List<Coding> securityLabel
A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels. -
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.
-
-
Class org.hl7.fhir.dstu3.model.Consent.ConsentActorComponent
class ConsentActorComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1152919415L
-
Serialized Fields
-
reference
Reference reference
The resource that identifies the actor. To identify a 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 a 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 consent.
-
-
Class org.hl7.fhir.dstu3.model.Consent.ConsentDataComponent
class ConsentDataComponent 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.dstu3.model.Consent.ConsentDataMeaningEnumFactory
class ConsentDataMeaningEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Consent.ConsentExceptTypeEnumFactory
class ConsentExceptTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.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.dstu3.model.Consent.ConsentStateEnumFactory
class ConsentStateEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Consent.ExceptActorComponent
class ExceptActorComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1152919415L
-
Serialized Fields
-
reference
Reference reference
The resource that identifies the actor. To identify a 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 a 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.dstu3.model.Consent.ExceptComponent
class ExceptComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1586636291L
-
Serialized Fields
-
action
List<CodeableConcept> action
Actions controlled by this Exception. -
actor
List<Consent.ExceptActorComponent> actor
Who or what is controlled by this Exception. 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 exception. 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<Coding> code
If this code is found in an instance, then the exception applies. -
data
List<Consent.ExceptDataComponent> data
The resources controlled by this exception, if specific resources are referenced. -
dataPeriod
Period dataPeriod
Clinical or Operational Relevant period of time that bounds the data controlled by this exception. -
period
Period period
The timeframe in this exception is valid. -
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 exception. -
securityLabel
List<Coding> securityLabel
A set of security labels that define which resources are controlled by this exception. If more than one label is specified, all resources must have all the specified labels. -
type
Enumeration<Consent.ConsentExceptType> type
Action to take - permit or deny - when the exception conditions are met.
-
-
Class org.hl7.fhir.dstu3.model.Consent.ExceptDataComponent
class ExceptDataComponent 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.dstu3.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.dstu3.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. Contacts are ranked with lower values coming before higher 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.dstu3.model.ContactPoint.ContactPointSystemEnumFactory
class ContactPointSystemEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.ContactPoint.ContactPointUseEnumFactory
class ContactPointUseEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Contract
class Contract extends DomainResource implements Serializable- serialVersionUID:
- -254555038L
-
Serialized Fields
-
action
List<CodeableConcept> action
Action stipulated by this Contract. -
actionReason
List<CodeableConcept> actionReason
Reason for action stipulated by this Contract. -
agent
List<Contract.AgentComponent> agent
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 is applicable. -
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.) -
binding
Type binding
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. -
contentDerivative
CodeableConcept contentDerivative
The minimal content derived from the basal information source at a specific stage in its lifecycle. -
decisionType
CodeableConcept decisionType
The type of decision made by a grantor with respect to an offer made by a grantee. -
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.) -
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
Identifier identifier
Unique identifier for this Contract. -
issued
DateTimeType issued
When this Contract was issued. -
legal
List<Contract.LegalLanguageComponent> legal
List of Legal expressions or representations of this Contract. -
rule
List<Contract.ComputableLanguageComponent> rule
List of Computable Policy Rule Language Representations of this Contract. -
securityLabel
List<Coding> securityLabel
A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels. -
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. -
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.) -
subType
List<CodeableConcept> subType
More specific type or specialization of an overarching or more general contract such as auto insurance, home owner insurance, prenupial agreement, Advanced-Directive, or privacy consent. -
term
List<Contract.TermComponent> term
One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups. -
topic
List<Reference> topic
The matter of concern in the context of this agreement. -
topicTarget
List<Resource> topicTarget
The actual objects that are the target of the reference (The matter of concern in the context of this agreement.) -
type
CodeableConcept type
Type of Contract such as an insurance policy, real estate contract, a will, power of attorny, Privacy or Security policy , trust framework agreement, etc. -
valuedItem
List<Contract.ValuedItemComponent> valuedItem
Contract Valued Item List.
-
-
Class org.hl7.fhir.dstu3.model.Contract.AgentComponent
class AgentComponent extends BackboneElement implements Serializable- serialVersionUID:
- -454551165L
-
Serialized Fields
-
actor
Reference actor
Who or what parties are assigned roles in this Contract. -
actorTarget
Resource actorTarget
The actual object that is the target of the reference (Who or what parties are assigned roles in this Contract.) -
role
List<CodeableConcept> role
Role type of agent assigned roles in this Contract.
-
-
Class org.hl7.fhir.dstu3.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.dstu3.model.Contract.ContractStatusEnumFactory
class ContractStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.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.dstu3.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.dstu3.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.dstu3.model.Contract.TermAgentComponent
class TermAgentComponent extends BackboneElement implements Serializable- serialVersionUID:
- -454551165L
-
Serialized Fields
-
actor
Reference actor
The agent assigned a role in this Contract Provision. -
actorTarget
Resource actorTarget
The actual object that is the target of the reference (The agent assigned a role in this Contract Provision.) -
role
List<CodeableConcept> role
Role played by the agent assigned this role in the execution of this Contract Provision.
-
-
Class org.hl7.fhir.dstu3.model.Contract.TermComponent
class TermComponent extends BackboneElement implements Serializable- serialVersionUID:
- 812661371L
-
Serialized Fields
-
action
List<CodeableConcept> action
Action stipulated by this Contract Provision. -
actionReason
List<CodeableConcept> actionReason
Reason or purpose for the action stipulated by this Contract Provision. -
agent
List<Contract.TermAgentComponent> agent
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. -
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. -
securityLabel
List<Coding> securityLabel
A set of security labels that define which terms are controlled by this condition. -
subType
CodeableConcept subType
Subtype of this Contract Provision, e.g. life time maximum payment for a contract term for specific valued item, e.g. disability payment. -
text
StringType text
Human readable form of this Contract Provision. -
topic
List<Reference> topic
The matter of concern in the context of this provision of the agrement. -
topicTarget
List<Resource> topicTarget
The actual objects that are the target of the reference (The matter of concern in the context of this provision of the agrement.) -
type
CodeableConcept type
Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit. -
valuedItem
List<Contract.TermValuedItemComponent> valuedItem
Contract Provision Valued Item List.
-
-
Class org.hl7.fhir.dstu3.model.Contract.TermValuedItemComponent
class TermValuedItemComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1782449516L
-
Serialized Fields
-
effectiveTime
DateTimeType effectiveTime
Indicates the time during which this Contract Term ValuedItem information is effective. -
entity
Type entity
Specific type of Contract Provision 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 Provision 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 Provision Valued Item instance. -
net
Money net
Expresses the product of the Contract Provision 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. -
points
DecimalType points
An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Provision Valued Item delivered. The concept of Points allows for assignment of point values for a Contract ProvisionValued Item, such that a monetary amount can be assigned to each point. -
quantity
SimpleQuantity quantity
Specifies the units by which the Contract Provision Valued Item is measured or counted, and quantifies the countable or measurable Contract Term Valued Item instances. -
unitPrice
Money unitPrice
A Contract Provision Valued Item unit valuation measure.
-
-
Class org.hl7.fhir.dstu3.model.Contract.ValuedItemComponent
class ValuedItemComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1782449516L
-
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. -
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. -
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
SimpleQuantity quantity
Specifies the units by which the Contract Valued Item is measured or counted, and quantifies the countable or measurable Contract Valued Item instances. -
unitPrice
Money unitPrice
A Contract Valued Item unit valuation measure.
-
-
Class org.hl7.fhir.dstu3.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.dstu3.model.Contributor.ContributorTypeEnumFactory
class ContributorTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Count
class Count extends Quantity implements Serializable- serialVersionUID:
- 0L
-
Class org.hl7.fhir.dstu3.model.Coverage
class Coverage extends DomainResource implements Serializable- serialVersionUID:
- -1719168406L
-
Serialized Fields
-
beneficiary
Reference beneficiary
The party who benefits from the insurance coverage., the patient when 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 services are provided.) -
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.) -
dependent
StringType dependent
A unique identifier for a dependent under the coverage. -
grouping
Coverage.GroupComponent grouping
A suite of underwrite specific classifiers, for example may be used to identify a class of coverage or employer group, Policy, Plan. -
identifier
List<Identifier> identifier
The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatination of the Coverage.SubscriberID and the Coverage.dependant. -
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 inforce. Note, there may be gaps in the numbering and this does not imply primary, secondard 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. May provide multiple identifiers such as insurance company identifier or business identifier (BIN number). -
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. May provide multiple identifiers such as insurance company identifier or business identifier (BIN number).) -
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, may be an individual, corporation or the subscriber's employer. -
policyHolderTarget
Resource policyHolderTarget
The actual object that is the target of the reference (The party who 'owns' the insurance policy, may be an individual, corporation or the subscriber's employer.) -
relationship
CodeableConcept relationship
The relationship of beneficiary (patient) to the subscriber. -
sequence
StringType sequence
An optional counter for a particular instance of the identified coverage which increments upon each renewal. -
status
Enumeration<Coverage.CoverageStatus> status
The status of the resource instance. -
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.dstu3.model.Coverage.CoverageStatusEnumFactory
class CoverageStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Coverage.GroupComponent
class GroupComponent extends BackboneElement implements Serializable- serialVersionUID:
- -13147121L
-
Serialized Fields
-
class_
StringType class_
Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage such as a level of deductables or co-payment. -
classDisplay
StringType classDisplay
A short description for the class. -
group
StringType group
Identifies a style or collective of coverage issued by the underwriter, for example may be used to identify an employer group. May also be referred to as a Policy or Group ID. -
groupDisplay
StringType groupDisplay
A short description for the group. -
plan
StringType plan
Identifies a style or collective of coverage issued by the underwriter, for example may be used to identify a collection of benefits provided to employees. May be referred to as a Section or Division ID. -
planDisplay
StringType planDisplay
A short description for the plan. -
subClass
StringType subClass
Identifies a sub-style or sub-collective of coverage issues by the underwriter, for example may be used to identify a subclass of coverage such as a sub-level of deductables or co-payment. -
subClassDisplay
StringType subClassDisplay
A short description for the subclass. -
subGroup
StringType subGroup
Identifies a style or collective of coverage issued by the underwriter, for example may be used to identify a subset of an employer group. -
subGroupDisplay
StringType subGroupDisplay
A short description for the subgroup. -
subPlan
StringType subPlan
Identifies a sub-style or sub-collective of coverage issued by the underwriter, for example may be used to identify a subset of a collection of benefits provided to employees. -
subPlanDisplay
StringType subPlanDisplay
A short description for the subplan.
-
-
Class org.hl7.fhir.dstu3.model.DataElement
class DataElement extends MetadataResource implements Serializable- serialVersionUID:
- 634422795L
-
Serialized Fields
-
copyright
MarkdownType copyright
A copyright statement relating to the data element and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the data element. -
element
List<ElementDefinition> element
Defines the structure, type, allowed values and other constraining characteristics of the data element. -
identifier
List<Identifier> identifier
A formal identifier that is used to identify this data element when it is represented in other formats, or referenced in a specification, model, design or an instance. -
mapping
List<DataElement.DataElementMappingComponent> mapping
Identifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with. -
stringency
Enumeration<DataElement.DataElementStringency> stringency
Identifies how precise the data element is in its definition.
-
-
Class org.hl7.fhir.dstu3.model.DataElement.DataElementMappingComponent
class DataElementMappingComponent 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 on a per-element basis. -
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.dstu3.model.DataElement.DataElementStringencyEnumFactory
class DataElementStringencyEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.DataRequirement
class DataRequirement extends Type implements Serializable- serialVersionUID:
- 274786645L
-
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. -
dateFilter
List<DataRequirement.DataRequirementDateFilterComponent> dateFilter
Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. -
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. Note that the value for this element can be a path to allow references to nested elements. In that case, all the elements along the path must be supported. -
profile
List<UriType> profile
The profile of the required data, specified as the uri of the profile definition. -
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.dstu3.model.DataRequirement.DataRequirementCodeFilterComponent
class DataRequirementCodeFilterComponent extends Element implements Serializable- serialVersionUID:
- -888422840L
-
Serialized Fields
-
path
StringType path
The code-valued attribute of the filter. 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. The path must resolve to an element of type code, Coding, or CodeableConcept. -
valueCode
List<CodeType> valueCode
The codes for the code filter. Only one of valueSet, valueCode, valueCoding, or valueCodeableConcept may be specified. 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. -
valueCodeableConcept
List<CodeableConcept> valueCodeableConcept
The CodeableConcepts for the code filter. Only one of valueSet, valueCode, valueConding, or valueCodeableConcept may be specified. 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 CodeableConcepts. -
valueCoding
List<Coding> valueCoding
The Codings for the code filter. Only one of valueSet, valueCode, valueConding, or valueCodeableConcept may be specified. 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 Codings. -
valueSet
Type valueSet
The valueset for the code filter. The valueSet and value elements are exclusive. 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.dstu3.model.DataRequirement.DataRequirementDateFilterComponent
class DataRequirementDateFilterComponent extends Element implements Serializable- serialVersionUID:
- 1791957163L
-
Serialized Fields
-
path
StringType path
The date-valued attribute of the filter. 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. The path must resolve to an element of type 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 from now.
-
-
Class org.hl7.fhir.dstu3.model.DateTimeType
class DateTimeType extends BaseDateTimeType implements Externalizable- serialVersionUID:
- 3L
-
Serialization Methods
-
readExternal
- Throws:
IOException
ClassNotFoundException
-
writeExternal
- Throws:
IOException
-
-
Class org.hl7.fhir.dstu3.model.DateType
class DateType extends BaseDateTimeType implements Externalizable- serialVersionUID:
- 3L
-
Serialization Methods
-
readExternal
- Throws:
IOException
ClassNotFoundException
-
writeExternal
- Throws:
IOException
-
-
Class org.hl7.fhir.dstu3.model.DecimalType
- serialVersionUID:
- 3L
-
Serialization Methods
-
readExternal
- Throws:
IOException
ClassNotFoundException
-
writeExternal
- Throws:
IOException
-
-
Class org.hl7.fhir.dstu3.model.DetectedIssue
class DetectedIssue extends DomainResource implements Serializable- serialVersionUID:
- -1002889332L
-
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.) -
category
CodeableConcept category
Identifies the general type of issue identified. -
date
DateTimeType date
The date or date-time when the detected issue was initially identified. -
detail
StringType detail
A textual explanation of the detected issue. -
identifier
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 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.dstu3.model.DetectedIssue.DetectedIssueMitigationComponent
class DetectedIssueMitigationComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1994768436L
-
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
Practitioner 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.dstu3.model.DetectedIssue.DetectedIssueSeverityEnumFactory
class DetectedIssueSeverityEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.DetectedIssue.DetectedIssueStatusEnumFactory
class DetectedIssueStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Device
class Device extends DomainResource implements Serializable- serialVersionUID:
- -1056263930L
-
Serialized Fields
-
contact
List<ContactPoint> contact
Contact details for an organization or a particular human that is responsible for the device. -
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. -
model
StringType model
The "model" is an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type. -
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.) -
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.) -
safety
List<CodeableConcept> safety
Provides additional safety characteristics about a medical device. For example devices containing latex. -
status
Enumeration<Device.FHIRDeviceStatus> status
Status of the Device availability. -
type
CodeableConcept type
Code or identifier to identify a kind of device. -
udi
Device.DeviceUdiComponent udi
[Unique device identifier (UDI)](device.html#5.11.3.2.2) assigned to device label or package. -
url
UriType url
A network address on which the device may be contacted directly. -
version
StringType version
The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.
-
-
Class org.hl7.fhir.dstu3.model.Device.DeviceUdiComponent
class DeviceUdiComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1105798343L
-
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. -
name
StringType name
Name of device as used in labeling or catalog.
-
-
Class org.hl7.fhir.dstu3.model.Device.FHIRDeviceStatusEnumFactory
class FHIRDeviceStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Device.UDIEntryTypeEnumFactory
class UDIEntryTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.DeviceComponent
class DeviceComponent extends DomainResource implements Serializable- serialVersionUID:
- 32987426L
-
Serialized Fields
-
identifier
Identifier identifier
The locally assigned unique identification by the software. For example: handle ID. -
languageCode
CodeableConcept languageCode
The language code for the human-readable text string produced by the device. This language code will follow the IETF language tag. Example: en-US. -
lastSystemChange
InstantType lastSystemChange
The timestamp for the most recent system change which includes device configuration or setting change. -
measurementPrinciple
Enumeration<DeviceComponent.MeasmntPrinciple> measurementPrinciple
The physical principle of the measurement. For example: thermal, chemical, acoustical, etc. -
operationalStatus
List<CodeableConcept> operationalStatus
The current operational status of the device. For example: On, Off, Standby, etc. -
parameterGroup
CodeableConcept parameterGroup
The parameter group supported by the current device component that is based on some nomenclature, e.g. cardiovascular. -
parent
Reference parent
The link to the parent resource. For example: Channel is linked to its VMD parent. -
parentTarget
DeviceComponent parentTarget
The actual object that is the target of the reference (The link to the parent resource. For example: Channel is linked to its VMD parent.) -
productionSpecification
List<DeviceComponent.DeviceComponentProductionSpecificationComponent> productionSpecification
The production specification such as component revision, serial number, etc. -
source
Reference source
The link to the source Device that contains administrative device information such as manufacture, serial number, etc. -
sourceTarget
Device sourceTarget
The actual object that is the target of the reference (The link to the source Device that contains administrative device information such as manufacture, serial number, etc.) -
type
CodeableConcept type
The component type as defined in the object-oriented or metric nomenclature partition.
-
-
Class org.hl7.fhir.dstu3.model.DeviceComponent.DeviceComponentProductionSpecificationComponent
class DeviceComponentProductionSpecificationComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1476597516L
-
Serialized Fields
-
componentId
Identifier componentId
The internal component unique identification. This is a provision for manufacture specific standard components using a private OID. 11073-10101 has a partition for private OID semantic that the manufacturer can make use of. -
productionSpec
StringType productionSpec
The printable string defining the component. -
specType
CodeableConcept specType
The specification type, such as, serial number, part number, hardware revision, software revision, etc.
-
-
Class org.hl7.fhir.dstu3.model.DeviceComponent.MeasmntPrincipleEnumFactory
class MeasmntPrincipleEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.DeviceMetric
class DeviceMetric extends DomainResource implements Serializable- serialVersionUID:
- -380567474L
-
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
Identifier identifier
Describes the unique identification of this metric that has been assigned by the device or gateway software. For example: handle ID. It should be noted that in order to make the identifier unique, the system element of the identifier should be set to the unique identifier of the device. -
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 DeviceComponent 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 DeviceComponent 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
DeviceComponent parentTarget
The actual object that is the target of the reference (Describes the link to the DeviceComponent 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 DeviceComponent 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.dstu3.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.dstu3.model.DeviceMetric.DeviceMetricCalibrationStateEnumFactory
class DeviceMetricCalibrationStateEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.DeviceMetric.DeviceMetricCalibrationTypeEnumFactory
class DeviceMetricCalibrationTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.DeviceMetric.DeviceMetricCategoryEnumFactory
class DeviceMetricCategoryEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.DeviceMetric.DeviceMetricColorEnumFactory
class DeviceMetricColorEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.DeviceMetric.DeviceMetricOperationalStatusEnumFactory
class DeviceMetricOperationalStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.DeviceRequest
class DeviceRequest extends DomainResource implements Serializable- serialVersionUID:
- -2002514925L
-
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. -
context
Reference context
An encounter that provides additional context in which this request is made. -
contextTarget
Resource contextTarget
The actual object that is the target of the reference (An encounter that provides additional context in which this request is made.) -
definition
List<Reference> definition
Protocol or definition followed by this request. For example: The proposed act must be performed if the indicated conditions occur, e.g.., shortness of breath, SpO2 less than x%. -
definitionTarget
List<Resource> definitionTarget
The actual objects that are the target of the reference (Protocol or definition followed by this request. For example: The proposed act must be performed if the indicated conditions occur, e.g.., shortness of breath, SpO2 less than x%.) -
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. -
intent
CodeableConcept 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". -
performer
Reference performer
The desired perfomer for doing the diagnostic testing. -
performerTarget
Resource performerTarget
The actual object that is the target of the reference (The desired perfomer 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
DeviceRequest.DeviceRequestRequesterComponent requester
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 includes body where on the subject's 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 includes body where on the subject's the device will be used ( i.e. the target site).)
-
-
Class org.hl7.fhir.dstu3.model.DeviceRequest.DeviceRequestRequesterComponent
class DeviceRequestRequesterComponent extends BackboneElement implements Serializable- serialVersionUID:
- -71453027L
-
Serialized Fields
-
agent
Reference agent
The device, practitioner, etc. who initiated the request. -
agentTarget
Resource agentTarget
The actual object that is the target of the reference (The device, practitioner, etc. who initiated the request.) -
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.dstu3.model.DeviceRequest.DeviceRequestStatusEnumFactory
class DeviceRequestStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.DeviceRequest.RequestPriorityEnumFactory
class RequestPriorityEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.DeviceUseStatement
class DeviceUseStatement extends DomainResource implements Serializable- serialVersionUID:
- 2144163845L
-
Serialized Fields
-
bodySite
CodeableConcept bodySite
Indicates the site on the subject's body where the device was used ( i.e. the target site). -
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. -
indication
List<CodeableConcept> indication
Reason or justification for the use of the device. -
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. -
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. -
whenUsed
Period whenUsed
The time period over which the device was used.
-
-
Class org.hl7.fhir.dstu3.model.DeviceUseStatement.DeviceUseStatementStatusEnumFactory
class DeviceUseStatementStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.DiagnosticReport
class DiagnosticReport extends DomainResource implements Serializable- serialVersionUID:
- 989012294L
-
Serialized Fields
-
basedOn
List<Reference> basedOn
Details concerning a test or procedure requested. -
basedOnTarget
List<Resource> basedOnTarget
The actual objects that are the target of the reference (Details concerning a test or procedure requested.) -
category
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. -
codedDiagnosis
List<CodeableConcept> codedDiagnosis
Codes for the conclusion. -
conclusion
StringType conclusion
Concise and clinically contextualized impression / summary of the diagnostic report. -
context
Reference context
The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport per is about. -
contextTarget
Resource contextTarget
The actual object that is the target of the reference (The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport per is about.) -
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. -
identifier
List<Identifier> identifier
Identifiers assigned to this report by the performer or other systems. -
image
List<DiagnosticReport.DiagnosticReportImageComponent> image
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). -
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<Resource> 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 released from the source diagnostic service. -
performer
List<DiagnosticReport.DiagnosticReportPerformerComponent> performer
Indicates who or what participated in producing 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 that are part of this diagnostic report. Observations can be simple name/value pairs (e.g. "atomic" results), or they can be grouping observations that include references to other members of the group (e.g. "panels"). -
resultTarget
List<Observation> resultTarget
The actual objects that are the target of the reference (Observations that are part of this diagnostic report. Observations can be simple name/value pairs (e.g. "atomic" results), or they can be grouping observations that include references to other members of the group (e.g. "panels").) -
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 as a whole. -
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.dstu3.model.DiagnosticReport.DiagnosticReportImageComponent
class DiagnosticReportImageComponent 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.dstu3.model.DiagnosticReport.DiagnosticReportPerformerComponent
class DiagnosticReportPerformerComponent extends BackboneElement implements Serializable- serialVersionUID:
- 805521719L
-
Serialized Fields
-
actor
Reference actor
The reference to the practitioner or organization involved in producing the report. For example, the diagnostic service that is responsible for issuing the report. -
actorTarget
Resource actorTarget
The actual object that is the target of the reference (The reference to the practitioner or organization involved in producing the report. For example, the diagnostic service that is responsible for issuing the report.) -
role
CodeableConcept role
Describes the type of participation (e.g. a responsible party, author, or verifier).
-
-
Class org.hl7.fhir.dstu3.model.DiagnosticReport.DiagnosticReportStatusEnumFactory
class DiagnosticReportStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Distance
class Distance extends Quantity implements Serializable- serialVersionUID:
- 0L
-
Class org.hl7.fhir.dstu3.model.DocumentManifest
class DocumentManifest extends DomainResource implements Serializable- serialVersionUID:
- -2081196115L
-
Serialized Fields
-
author
List<Reference> author
Identifies who is responsible for creating the manifest, and adding documents to it. -
authorTarget
List<Resource> authorTarget
The actual objects that are the target of the reference (Identifies who is responsible for creating the manifest, and adding documents to it.) -
content
List<DocumentManifest.DocumentManifestContentComponent> content
The list of Documents included in the 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
Specifies the kind of this set of documents (e.g. Patient Summary, Discharge Summary, Prescription, etc.). The type of a set of documents may be the same as one of the documents in it - especially if there is only one - but it may be wider.
-
-
Class org.hl7.fhir.dstu3.model.DocumentManifest.DocumentManifestContentComponent
class DocumentManifestContentComponent extends BackboneElement implements Serializable- serialVersionUID:
- -347538500L
-
Serialized Fields
-
p
Type p
The list of references to document content, or Attachment that consist of the parts of this document manifest. Usually, these would be document references, but direct references to Media or Attachments are also allowed.
-
-
Class org.hl7.fhir.dstu3.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, ProcedureRequest, Procedure, EligibilityRequest, etc. -
refTarget
Resource refTarget
The actual object that is the target of the reference (Related Resource to this DocumentManifest. For example, Order, ProcedureRequest, Procedure, EligibilityRequest, etc.)
-
-
Class org.hl7.fhir.dstu3.model.DocumentReference
class DocumentReference extends DomainResource implements Serializable- serialVersionUID:
- 1465770040L
-
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.) -
class_
CodeableConcept class_
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. -
created
DateTimeType created
When the document was created. -
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.) -
description
StringType description
Human-readable description of the source document. This is sometimes known as the "title". -
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. -
indexed
InstantType indexed
When the document reference was created. -
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.dstu3.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.dstu3.model.DocumentReference.DocumentReferenceContextComponent
class DocumentReferenceContextComponent extends BackboneElement implements Serializable- serialVersionUID:
- 994799273L
-
Serialized Fields
-
encounter
Reference encounter
Describes the clinical encounter or type of care that the document content is associated with. -
encounterTarget
Encounter encounterTarget
The actual object that is 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 typeCode, 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<DocumentReference.DocumentReferenceContextRelatedComponent> related
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.dstu3.model.DocumentReference.DocumentReferenceContextRelatedComponent
class DocumentReferenceContextRelatedComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1670123330L
-
Serialized Fields
-
identifier
Identifier identifier
Related identifier to this DocumentReference. If both id and ref are present they shall refer to the same thing. -
ref
Reference ref
Related Resource to this DocumentReference. If both id and ref are present they shall refer to the same thing. -
refTarget
Resource refTarget
The actual object that is the target of the reference (Related Resource to this DocumentReference. If both id and ref are present they shall refer to the same thing.)
-
-
Class org.hl7.fhir.dstu3.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.dstu3.model.DocumentReference.DocumentRelationshipTypeEnumFactory
class DocumentRelationshipTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.DocumentReference.ReferredDocumentStatusEnumFactory
class ReferredDocumentStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.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. 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. -
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. 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. -
text
Narrative text
A human-readable narrative that contains a summary of the resource, and may 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.dstu3.model.Dosage
class Dosage extends Type implements Serializable- serialVersionUID:
- 70626458L
-
Serialized Fields
-
additionalInstruction
List<CodeableConcept> additionalInstruction
Supplemental instruction - e.g. "with meals". -
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). -
dose
Type dose
Amount of medication per dose. -
maxDosePerAdministration
SimpleQuantity maxDosePerAdministration
Upper limit on medication per administration. -
maxDosePerLifetime
SimpleQuantity 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. -
rate
Type rate
Amount of medication per unit of time. -
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.dstu3.model.Duration
class Duration extends Quantity implements Serializable- serialVersionUID:
- 0L
-
Class org.hl7.fhir.dstu3.model.Element
class Element extends Base implements Serializable- serialVersionUID:
- -1452745816L
-
Serialized Fields
-
extension
List<Extension> extension
May be used to represent additional information that is not part of the basic definition of the element. 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. -
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.dstu3.model.ElementDefinition
class ElementDefinition extends Type implements Serializable- serialVersionUID:
- -278262340L
-
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. This information is provided 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. -
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. -
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 the identity of an element defined elsewhere in the profile whose content rules should be applied to the current element. -
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. -
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. -
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. -
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. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.). -
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). -
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.dstu3.model.ElementDefinition.AggregationModeEnumFactory
class AggregationModeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.ElementDefinition.ConstraintSeverityEnumFactory
class ConstraintSeverityEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.ElementDefinition.DiscriminatorTypeEnumFactory
class DiscriminatorTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.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.dstu3.model.ElementDefinition.ElementDefinitionBindingComponent
class ElementDefinitionBindingComponent extends Element implements Serializable- serialVersionUID:
- 1355538460L
-
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
Type valueSet
Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used. If the binding refers to an explicit value set - the normal case - then use a Reference(ValueSet) preferably containing the canonical URL for the value set. If the reference is to an implicit value set - usually, an IETF RFC that defines a grammar, such as mime types - then use a uri.
-
-
Class org.hl7.fhir.dstu3.model.ElementDefinition.ElementDefinitionConstraintComponent
class ElementDefinitionConstraintComponent extends Element implements Serializable- serialVersionUID:
- 1860862205L
-
Serialized Fields
-
expression
StringType expression
A [FHIRPath](http://hl7.org/fluentpath) 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
UriType 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.dstu3.model.ElementDefinition.ElementDefinitionExampleComponent
class ElementDefinitionExampleComponent extends Element implements Serializable- serialVersionUID:
- 1346348024L
-
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.dstu3.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.dstu3.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.dstu3.model.ElementDefinition.ElementDefinitionSlicingDiscriminatorComponent
class ElementDefinitionSlicingDiscriminatorComponent extends Element implements Serializable- serialVersionUID:
- 1151159293L
-
Serialized Fields
-
path
StringType path
A FHIRPath expression, using a restricted subset of FHIRPath, 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.dstu3.model.ElementDefinition.PropertyRepresentationEnumFactory
class PropertyRepresentationEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.ElementDefinition.ReferenceVersionRulesEnumFactory
class ReferenceVersionRulesEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.ElementDefinition.SlicingRulesEnumFactory
class SlicingRulesEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.ElementDefinition.TypeRefComponent
class TypeRefComponent extends Element implements Serializable- serialVersionUID:
- -560921355L
-
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
UriType profile
Identifies a profile structure or implementation Guide that SHALL hold for the datatype this element refers to. 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 resource SHALL conform to at least one profile defined in the implementation guide. -
targetProfile
UriType targetProfile
Identifies a profile structure or implementation Guide that SHALL hold for the target of the reference this element refers to. 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 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.dstu3.model.EligibilityRequest
class EligibilityRequest extends DomainResource implements Serializable- serialVersionUID:
- 899259023L
-
Serialized Fields
-
benefitCategory
CodeableConcept benefitCategory
Dental, Vision, Medical, Pharmacy, Rehab etc. -
benefitSubCategory
CodeableConcept benefitSubCategory
Dental: basic, major, ortho; Vision exam, glasses, contacts; etc. -
businessArrangement
StringType businessArrangement
The contract number of a business agreement which describes the terms and conditions. -
coverage
Reference coverage
Financial instrument by which payment information for health care. -
coverageTarget
Coverage coverageTarget
The actual object that is the target of the reference (Financial instrument by which payment information for health care.) -
created
DateTimeType created
The date when this resource was created. -
enterer
Reference enterer
Person who created the invoice/claim/pre-determination or pre-authorization. -
entererTarget
Practitioner entererTarget
The actual object that is the target of the reference (Person who created the invoice/claim/pre-determination or pre-authorization.) -
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.) -
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.) -
organization
Reference organization
The organization which is responsible for the services rendered to the patient. -
organizationTarget
Organization organizationTarget
The actual object that is the target of the reference (The organization which is responsible for the services rendered to the patient.) -
patient
Reference patient
Patient Resource. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (Patient Resource.) -
priority
CodeableConcept priority
Immediate (STAT), best effort (NORMAL), deferred (DEFER). -
provider
Reference provider
The practitioner who is responsible for the services rendered to the patient. -
providerTarget
Practitioner providerTarget
The actual object that is the target of the reference (The practitioner who is responsible for the services rendered to the patient.) -
serviced
Type serviced
The date or dates when the enclosed suite of services were performed or completed. -
status
Enumeration<EligibilityRequest.EligibilityRequestStatus> status
The status of the resource instance.
-
-
Class org.hl7.fhir.dstu3.model.EligibilityRequest.EligibilityRequestStatusEnumFactory
class EligibilityRequestStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.EligibilityResponse
class EligibilityResponse extends DomainResource implements Serializable- serialVersionUID:
- 954270539L
-
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. -
error
List<EligibilityResponse.ErrorsComponent> error
Mutually exclusive with Services Provided (Item). -
form
CodeableConcept form
The form to be used for printing the content. -
identifier
List<Identifier> identifier
The Response business identifier. -
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. -
insurance
List<EligibilityResponse.InsuranceComponent> insurance
The insurer may provide both the details for the requested coverage as well as details for additional coverages known to the insurer. -
insurer
Reference insurer
The Insurer who produced this adjudicated response. -
insurerTarget
Organization insurerTarget
The actual object that is the target of the reference (The Insurer who produced this adjudicated response.) -
outcome
CodeableConcept outcome
Transaction status: error, complete. -
request
Reference request
Original request resource reference. -
requestOrganization
Reference requestOrganization
The organization which is responsible for the services rendered to the patient. -
requestOrganizationTarget
Organization requestOrganizationTarget
The actual object that is the target of the reference (The organization which is responsible for the services rendered to the patient.) -
requestProvider
Reference requestProvider
The practitioner who is responsible for the services rendered to the patient. -
requestProviderTarget
Practitioner requestProviderTarget
The actual object that is the target of the reference (The practitioner who is responsible for the services rendered to the patient.) -
requestTarget
EligibilityRequest requestTarget
The actual object that is the target of the reference (Original request resource reference.) -
status
Enumeration<EligibilityResponse.EligibilityResponseStatus> status
The status of the resource instance.
-
-
Class org.hl7.fhir.dstu3.model.EligibilityResponse.BenefitComponent
class BenefitComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1506285314L
-
Serialized Fields
-
allowed
Type allowed
Benefits allowed. -
type
CodeableConcept type
Deductable, visits, benefit amount. -
used
Type used
Benefits used.
-
-
Class org.hl7.fhir.dstu3.model.EligibilityResponse.BenefitsComponent
class BenefitsComponent extends BackboneElement implements Serializable- serialVersionUID:
- 833826021L
-
Serialized Fields
-
category
CodeableConcept category
Dental, Vision, Medical, Pharmacy, Rehab etc. -
description
StringType description
A richer description of the benefit, for example 'DENT2 covers 100% of basic, 50% of major but exclused Ortho, Implants and Costmetic services'. -
excluded
BooleanType excluded
True if the indicated class of service is excluded from the plan, missing or False indicated the service is included in the coverage. -
financial
List<EligibilityResponse.BenefitComponent> financial
Benefits Used to date. -
name
StringType name
A short name or tag for the benefit, for example MED01, or DENT2. -
network
CodeableConcept network
Network designation. -
subCategory
CodeableConcept subCategory
Dental: basic, major, ortho; Vision exam, glasses, contacts; etc. -
term
CodeableConcept term
The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual vistis'. -
unit
CodeableConcept unit
Unit designation: individual or family.
-
-
Class org.hl7.fhir.dstu3.model.EligibilityResponse.EligibilityResponseStatusEnumFactory
class EligibilityResponseStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.EligibilityResponse.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.dstu3.model.EligibilityResponse.InsuranceComponent
class InsuranceComponent extends BackboneElement implements Serializable- serialVersionUID:
- 821384102L
-
Serialized Fields
-
benefitBalance
List<EligibilityResponse.BenefitsComponent> benefitBalance
Benefits and optionally current balances by Category. -
contract
Reference contract
The contract resource which may provide more detailed information. -
contractTarget
Contract contractTarget
The actual object that is the target of the reference (The contract resource which may provide more detailed information.) -
coverage
Reference coverage
A suite of updated or additional Coverages from the Insurer. -
coverageTarget
Coverage coverageTarget
The actual object that is the target of the reference (A suite of updated or additional Coverages from the Insurer.)
-
-
Class org.hl7.fhir.dstu3.model.Encounter
class Encounter extends DomainResource implements Serializable- serialVersionUID:
- 2124102382L
-
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
Reference appointment
The appointment that scheduled this encounter. -
appointmentTarget
Appointment appointmentTarget
The actual object that is the target of the reference (The appointment that scheduled this encounter.) -
class_
Coding class_
inpatient | outpatient | ambulatory | emergency +. -
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 transisions 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 kindof 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. -
incomingReferral
List<Reference> incomingReferral
The referral request this encounter satisfies (incoming referral). -
incomingReferralTarget
List<ReferralRequest> incomingReferralTarget
The actual objects that are the target of the reference (The referral request this encounter satisfies (incoming referral).) -
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. -
reason
List<CodeableConcept> reason
Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis. -
serviceProvider
Reference serviceProvider
An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization. -
serviceProviderTarget
Organization serviceProviderTarget
The actual object that is the target of the reference (An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.) -
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 ro group present at the encounter. -
subjectTarget
Resource subjectTarget
The actual object that is the target of the reference (The patient ro 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.dstu3.model.Encounter.ClassHistoryComponent
class ClassHistoryComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1331020311L
-
Class org.hl7.fhir.dstu3.model.Encounter.DiagnosisComponent
class DiagnosisComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1005913665L
-
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). -
role
CodeableConcept role
Role that this diagnosis has within the encounter (e.g. admission, billing, discharge ?).
-
-
Class org.hl7.fhir.dstu3.model.Encounter.EncounterHospitalizationComponent
class EncounterHospitalizationComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1165804076L
-
Serialized Fields
-
admitSource
CodeableConcept admitSource
From where patient was admitted (physician referral, transfer). -
destination
Reference destination
Location to which the patient is discharged. -
destinationTarget
Location destinationTarget
The actual object that is the target of the reference (Location 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 from which the patient came before admission. -
originTarget
Location originTarget
The actual object that is the target of the reference (The location 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.dstu3.model.Encounter.EncounterLocationComponent
class EncounterLocationComponent extends BackboneElement implements Serializable- serialVersionUID:
- -322984880L
-
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. -
status
Enumeration<Encounter.EncounterLocationStatus> status
The status of the participants' presence at the specified location during the period specified. If the participant is is no longer at the location, then the period will have an end date/time.
-
-
Class org.hl7.fhir.dstu3.model.Encounter.EncounterLocationStatusEnumFactory
class EncounterLocationStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.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.dstu3.model.Encounter.EncounterStatusEnumFactory
class EncounterStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.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.dstu3.model.Endpoint
class Endpoint extends DomainResource implements Serializable- serialVersionUID:
- 694168955L
-
Serialized Fields
-
address
UriType 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 organisation is hosting this in the cloud, it is the organisation 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 organisation is hosting this in the cloud, it is the organisation 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.dstu3.model.Endpoint.EndpointStatusEnumFactory
class EndpointStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.EnrollmentRequest
class EnrollmentRequest extends DomainResource implements Serializable- serialVersionUID:
- -214445454L
-
Serialized Fields
-
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.) -
organization
Reference organization
The organization which is responsible for the services rendered to the patient. -
organizationTarget
Organization organizationTarget
The actual object that is the target of the reference (The organization which is responsible for the services rendered to the patient.) -
provider
Reference provider
The practitioner who is responsible for the services rendered to the patient. -
providerTarget
Practitioner 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. -
subject
Reference subject
Patient Resource. -
subjectTarget
Patient subjectTarget
The actual object that is the target of the reference (Patient Resource.)
-
-
Class org.hl7.fhir.dstu3.model.EnrollmentRequest.EnrollmentRequestStatusEnumFactory
class EnrollmentRequestStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.EnrollmentResponse
class EnrollmentResponse extends DomainResource implements Serializable- serialVersionUID:
- -386781115L
-
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
CodeableConcept outcome
Processing status: error, complete. -
request
Reference request
Original request resource reference. -
requestOrganization
Reference requestOrganization
The organization which is responsible for the services rendered to the patient. -
requestOrganizationTarget
Organization requestOrganizationTarget
The actual object that is the target of the reference (The organization which is responsible for the services rendered to the patient.) -
requestProvider
Reference requestProvider
The practitioner who is responsible for the services rendered to the patient. -
requestProviderTarget
Practitioner 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.dstu3.model.EnrollmentResponse.EnrollmentResponseStatusEnumFactory
class EnrollmentResponseStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Enumeration
- serialVersionUID:
- 1L
-
Serialization Methods
-
readExternal
- Throws:
IOException
ClassNotFoundException
-
writeExternal
- Throws:
IOException
-
-
Class org.hl7.fhir.dstu3.model.Enumerations.AbstractTypeEnumFactory
class AbstractTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Enumerations.AdministrativeGenderEnumFactory
class AdministrativeGenderEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Enumerations.AgeUnitsEnumFactory
class AgeUnitsEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Enumerations.BindingStrengthEnumFactory
class BindingStrengthEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Enumerations.ConceptMapEquivalenceEnumFactory
class ConceptMapEquivalenceEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Enumerations.DataAbsentReasonEnumFactory
class DataAbsentReasonEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Enumerations.DataTypeEnumFactory
class DataTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Enumerations.DocumentReferenceStatusEnumFactory
class DocumentReferenceStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Enumerations.FHIRAllTypesEnumFactory
class FHIRAllTypesEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Enumerations.FHIRDefinedTypeEnumFactory
class FHIRDefinedTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Enumerations.MessageEventEnumFactory
class MessageEventEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Enumerations.NoteTypeEnumFactory
class NoteTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Enumerations.PublicationStatusEnumFactory
class PublicationStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Enumerations.RemittanceOutcomeEnumFactory
class RemittanceOutcomeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Enumerations.ResourceTypeEnumFactory
class ResourceTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Enumerations.SearchParamTypeEnumFactory
class SearchParamTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Enumerations.SpecialValuesEnumFactory
class SpecialValuesEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.EpisodeOfCare
class EpisodeOfCare extends DomainResource implements Serializable- serialVersionUID:
- 76719771L
-
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 co-ordinator for this patient. -
careManagerTarget
Practitioner careManagerTarget
The actual object that is the target of the reference (The practitioner that is the care manager/care co-ordinator 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<ReferralRequest> 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.dstu3.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.dstu3.model.EpisodeOfCare.EpisodeOfCareStatusEnumFactory
class EpisodeOfCareStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.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.dstu3.model.ExpansionProfile
class ExpansionProfile extends MetadataResource implements Serializable- serialVersionUID:
- 1067457001L
-
Serialized Fields
-
activeOnly
BooleanType activeOnly
Controls whether inactive concepts are included or excluded in value set expansions. -
designation
ExpansionProfile.ExpansionProfileDesignationComponent designation
A set of criteria that provide the constraints imposed on the value set expansion by including or excluding designations. -
displayLanguage
CodeType displayLanguage
Specifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.display. -
excludedSystem
ExpansionProfile.ExpansionProfileExcludedSystemComponent excludedSystem
Code system, or a particular version of a code system to be excluded from value set expansions. -
excludeNested
BooleanType excludeNested
Controls whether or not the value set expansion nests codes or not (i.e. ValueSet.expansion.contains.contains). -
excludeNotForUI
BooleanType excludeNotForUI
Controls whether or not the value set expansion includes codes which cannot be displayed in user interfaces. -
excludePostCoordinated
BooleanType excludePostCoordinated
Controls whether or not the value set expansion includes post coordinated codes. -
fixedVersion
List<ExpansionProfile.ExpansionProfileFixedVersionComponent> fixedVersion
Fix use of a particular code system to a particular version. -
identifier
Identifier identifier
A formal identifier that is used to identify this expansion profile when it is represented in other formats, or referenced in a specification, model, design or an instance. -
includeDefinition
BooleanType includeDefinition
Controls whether the value set definition is included or excluded in value set expansions. -
includeDesignations
BooleanType includeDesignations
Controls whether concept designations are to be included or excluded in value set expansions. -
limitedExpansion
BooleanType limitedExpansion
If the value set being expanded is incomplete (because it is too big to expand), return a limited expansion (a subset) with an indicator that expansion is incomplete, using the extension [http://hl7.org/fhir/StructureDefinition/valueset-toocostly](extension-valueset-toocostly.html).
-
-
Class org.hl7.fhir.dstu3.model.ExpansionProfile.DesignationExcludeComponent
class DesignationExcludeComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1045849752L
-
Serialized Fields
-
designation
List<ExpansionProfile.DesignationExcludeDesignationComponent> designation
A data group for each designation to be excluded.
-
-
Class org.hl7.fhir.dstu3.model.ExpansionProfile.DesignationExcludeDesignationComponent
class DesignationExcludeDesignationComponent extends BackboneElement implements Serializable- serialVersionUID:
- 242239292L
-
Class org.hl7.fhir.dstu3.model.ExpansionProfile.DesignationIncludeComponent
class DesignationIncludeComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1989669274L
-
Serialized Fields
-
designation
List<ExpansionProfile.DesignationIncludeDesignationComponent> designation
A data group for each designation to be included.
-
-
Class org.hl7.fhir.dstu3.model.ExpansionProfile.DesignationIncludeDesignationComponent
class DesignationIncludeDesignationComponent extends BackboneElement implements Serializable- serialVersionUID:
- 242239292L
-
Class org.hl7.fhir.dstu3.model.ExpansionProfile.ExpansionProfileDesignationComponent
class ExpansionProfileDesignationComponent extends BackboneElement implements Serializable- serialVersionUID:
- -2080476436L
-
Serialized Fields
-
exclude
ExpansionProfile.DesignationExcludeComponent exclude
Designations to be excluded. -
include
ExpansionProfile.DesignationIncludeComponent include
Designations to be included.
-
-
Class org.hl7.fhir.dstu3.model.ExpansionProfile.ExpansionProfileExcludedSystemComponent
class ExpansionProfileExcludedSystemComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1145288774L
-
Serialized Fields
-
system
UriType system
An absolute URI which is the code system to be excluded. -
version
StringType version
The version of the code system from which codes in the expansion should be excluded.
-
-
Class org.hl7.fhir.dstu3.model.ExpansionProfile.ExpansionProfileFixedVersionComponent
class ExpansionProfileFixedVersionComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1818466753L
-
Serialized Fields
-
mode
Enumeration<ExpansionProfile.SystemVersionProcessingMode> mode
How to manage the intersection between a fixed version in a value set, and this fixed version of the system in the expansion profile. -
system
UriType system
The specific system for which to fix the version. -
version
StringType version
The version of the code system from which codes in the expansion should be included.
-
-
Class org.hl7.fhir.dstu3.model.ExpansionProfile.SystemVersionProcessingModeEnumFactory
class SystemVersionProcessingModeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.ExplanationOfBenefit
class ExplanationOfBenefit extends DomainResource implements Serializable- serialVersionUID:
- -1301056913L
-
Serialized Fields
-
accident
ExplanationOfBenefit.AccidentComponent accident
An accident which resulted in the need for healthcare services. -
addItem
List<ExplanationOfBenefit.AddedItemComponent> addItem
The first tier service adjudications for payor added services. -
benefitBalance
List<ExplanationOfBenefit.BenefitBalanceComponent> benefitBalance
Balance by Benefit Category. -
billablePeriod
Period billablePeriod
The billable period for which charges are being submitted. -
careTeam
List<ExplanationOfBenefit.CareTeamComponent> careTeam
The members of the team who provided the overall service as well as their role and whether responsible and qualifications. -
claim
Reference claim
The business identifier for the instance: invoice number, claim number, pre-determination or pre-authorization number. -
claimResponse
Reference claimResponse
The business identifier for the instance: invoice number, claim number, pre-determination or pre-authorization number. -
claimResponseTarget
ClaimResponse claimResponseTarget
The actual object that is the target of the reference (The business identifier for the instance: invoice number, claim number, pre-determination or pre-authorization number.) -
claimTarget
Claim claimTarget
The actual object that is the target of the reference (The business identifier for the instance: invoice number, claim number, pre-determination or pre-authorization number.) -
created
DateTimeType created
The date when the EOB was created. -
diagnosis
List<ExplanationOfBenefit.DiagnosisComponent> diagnosis
Ordered list of patient diagnosis for which care is sought. -
disposition
StringType disposition
A description of the status of the adjudication. -
employmentImpacted
Period employmentImpacted
The start and optional end dates of when the patient was precluded from working due to the treatable condition(s). -
enterer
Reference enterer
The person who created the explanation of benefit. -
entererTarget
Practitioner entererTarget
The actual object that is the target of the reference (The person who created the explanation of benefit.) -
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
CodeableConcept form
The form to be used for printing the content. -
hospitalization
Period hospitalization
The start and optional end dates of when the patient was confined to a treatment center. -
identifier
List<Identifier> identifier
The EOB Business Identifier. -
information
List<ExplanationOfBenefit.SupportingInformationComponent> information
Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. Often there are mutiple jurisdiction specific valuesets which are required. -
insurance
ExplanationOfBenefit.InsuranceComponent insurance
Financial instrument by which payment information for health care. -
insurer
Reference insurer
The insurer which is responsible for the explanation of benefit. -
insurerTarget
Organization insurerTarget
The actual object that is the target of the reference (The insurer which is responsible for the explanation of benefit.) -
item
List<ExplanationOfBenefit.ItemComponent> item
First tier of goods and services. -
organization
Reference organization
The provider which is responsible for the claim. -
organizationTarget
Organization organizationTarget
The actual object that is the target of the reference (The provider which is responsible for the claim.) -
originalPrescription
Reference originalPrescription
Original prescription which has been superceded by this prescription to support the dispensing of pharmacy services, medications or products. For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefor issues a new precription for an alternate medication which has the same theraputic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'. -
originalPrescriptionTarget
MedicationRequest originalPrescriptionTarget
The actual object that is the target of the reference (Original prescription which has been superceded by this prescription to support the dispensing of pharmacy services, medications or products. For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefor issues a new precription for an alternate medication which has the same theraputic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'.) -
outcome
CodeableConcept outcome
Processing outcome errror, partial or complete processing. -
patient
Reference patient
Patient Resource. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (Patient Resource.) -
payee
ExplanationOfBenefit.PayeeComponent payee
The party to be reimbursed for the services. -
payment
ExplanationOfBenefit.PaymentComponent payment
Payment details for the claim if the claim has been paid. -
precedence
PositiveIntType precedence
Precedence (primary, secondary, etc.). -
prescription
Reference prescription
Prescription to support the dispensing of Pharmacy or Vision products. -
prescriptionTarget
Resource prescriptionTarget
The actual object that is the target of the reference (Prescription to support the dispensing of Pharmacy or Vision products.) -
procedure
List<ExplanationOfBenefit.ProcedureComponent> procedure
Ordered list of patient procedures performed to support the adjudication. -
processNote
List<ExplanationOfBenefit.NoteComponent> processNote
Note text. -
provider
Reference provider
The provider which is responsible for the claim. -
providerTarget
Practitioner providerTarget
The actual object that is the target of the reference (The provider which is responsible for the claim.) -
referral
Reference referral
The referral resource which lists the date, practitioner, reason and other supporting information. -
referralTarget
ReferralRequest referralTarget
The actual object that is the target of the reference (The referral resource which lists the date, practitioner, reason and other supporting information.) -
related
List<ExplanationOfBenefit.RelatedClaimComponent> related
Other claims which are related to this claim such as prior claim versions or for related services. -
status
Enumeration<ExplanationOfBenefit.ExplanationOfBenefitStatus> status
The status of the resource instance. -
subType
List<CodeableConcept> subType
A finer grained suite of claim subtype codes which may convey Inpatient vs Outpatient and/or a specialty service. In the US the BillType. -
totalBenefit
Money totalBenefit
Total amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductable). -
totalCost
Money totalCost
The total cost of the services reported. -
type
CodeableConcept type
The category of claim, eg, oral, pharmacy, vision, insitutional, professional. -
unallocDeductable
Money unallocDeductable
The amount of deductable applied which was not allocated to any particular service line.
-
-
Class org.hl7.fhir.dstu3.model.ExplanationOfBenefit.AccidentComponent
class AccidentComponent extends BackboneElement implements Serializable- serialVersionUID:
- 622904984L
-
Serialized Fields
-
date
DateType date
Date of an accident which these services are addressing. -
location
Type location
Where the accident occurred. -
type
CodeableConcept type
Type of accident: work, auto, etc.
-
-
Class org.hl7.fhir.dstu3.model.ExplanationOfBenefit.AddedItemComponent
class AddedItemComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1969703165L
-
Serialized Fields
-
adjudication
List<ExplanationOfBenefit.AdjudicationComponent> adjudication
The adjudications results. -
category
CodeableConcept category
Health Care Service Type Codes to identify the classification of service or benefits. -
detail
List<ExplanationOfBenefit.AddedItemsDetailComponent> detail
The second tier service adjudications for payor added services. -
fee
Money fee
The fee charged for the professional service or product. -
modifier
List<CodeableConcept> modifier
Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours. -
noteNumber
List<PositiveIntType> noteNumber
A list of note references to the notes provided below. -
revenue
CodeableConcept revenue
The type of reveneu or cost center providing the product and/or service. -
sequenceLinkId
List<PositiveIntType> sequenceLinkId
List of input service items which this service line is intended to replace. -
service
CodeableConcept service
If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. 'glasses' or 'compound'.
-
-
Class org.hl7.fhir.dstu3.model.ExplanationOfBenefit.AddedItemsDetailComponent
class AddedItemsDetailComponent extends BackboneElement implements Serializable- serialVersionUID:
- -311484980L
-
Serialized Fields
-
adjudication
List<ExplanationOfBenefit.AdjudicationComponent> adjudication
The adjudications results. -
category
CodeableConcept category
Health Care Service Type Codes to identify the classification of service or benefits. -
fee
Money fee
The fee charged for the professional service or product. -
modifier
List<CodeableConcept> modifier
Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours. -
noteNumber
List<PositiveIntType> noteNumber
A list of note references to the notes provided below. -
revenue
CodeableConcept revenue
The type of reveneu or cost center providing the product and/or service. -
service
CodeableConcept service
A code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI).
-
-
Class org.hl7.fhir.dstu3.model.ExplanationOfBenefit.AdjudicationComponent
class AdjudicationComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1559898786L
-
Serialized Fields
-
amount
Money amount
Monitory amount associated with the code. -
category
CodeableConcept category
Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc. -
reason
CodeableConcept reason
Adjudication reason such as limit reached. -
value
DecimalType value
A non-monetary value for example a percentage. Mutually exclusive to the amount element above.
-
-
Class org.hl7.fhir.dstu3.model.ExplanationOfBenefit.BenefitBalanceComponent
class BenefitBalanceComponent extends BackboneElement implements Serializable- serialVersionUID:
- 833826021L
-
Serialized Fields
-
category
CodeableConcept category
Dental, Vision, Medical, Pharmacy, Rehab etc. -
description
StringType description
A richer description of the benefit, for example 'DENT2 covers 100% of basic, 50% of major but exclused Ortho, Implants and Costmetic services'. -
excluded
BooleanType excluded
True if the indicated class of service is excluded from the plan, missing or False indicated the 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, for example MED01, or DENT2. -
network
CodeableConcept network
Network designation. -
subCategory
CodeableConcept subCategory
Dental: basic, major, ortho; Vision exam, glasses, contacts; etc. -
term
CodeableConcept term
The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual vistis'. -
unit
CodeableConcept unit
Unit designation: individual or family.
-
-
Class org.hl7.fhir.dstu3.model.ExplanationOfBenefit.BenefitComponent
class BenefitComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1506285314L
-
Serialized Fields
-
allowed
Type allowed
Benefits allowed. -
type
CodeableConcept type
Deductable, visits, benefit amount. -
used
Type used
Benefits used.
-
-
Class org.hl7.fhir.dstu3.model.ExplanationOfBenefit.CareTeamComponent
class CareTeamComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1758966968L
-
Serialized Fields
-
provider
Reference provider
The members of the team who provided the overall service. -
providerTarget
Resource providerTarget
The actual object that is the target of the reference (The members of the team who provided the overall service.) -
qualification
CodeableConcept qualification
The qualification which is applicable for this service. -
responsible
BooleanType responsible
The practitioner who is billing and responsible for the claimed services rendered to the patient. -
role
CodeableConcept role
The lead, assisting or supervising practitioner and their discipline if a multidisiplinary team. -
sequence
PositiveIntType sequence
Sequence of careteam which serves to order and provide a link.
-
-
Class org.hl7.fhir.dstu3.model.ExplanationOfBenefit.DetailComponent
class DetailComponent extends BackboneElement implements Serializable- serialVersionUID:
- -276371489L
-
Serialized Fields
-
adjudication
List<ExplanationOfBenefit.AdjudicationComponent> adjudication
The adjudications results. -
category
CodeableConcept category
Health Care Service Type Codes to identify the classification of service or benefits. -
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, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours. -
net
Money net
The quantity times the unit price for an addittional service or product or charge. 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. -
noteNumber
List<PositiveIntType> noteNumber
A list of note references to the notes provided below. -
programCode
List<CodeableConcept> programCode
For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program. -
quantity
SimpleQuantity quantity
The number of repetitions of a service or product. -
revenue
CodeableConcept revenue
The type of reveneu or cost center providing the product and/or service. -
sequence
PositiveIntType sequence
A service line number. -
service
CodeableConcept service
If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. 'glasses' or 'compound'. -
subDetail
List<ExplanationOfBenefit.SubDetailComponent> subDetail
Third tier of goods and services. -
type
CodeableConcept type
The type of product or service. -
udi
List<Reference> udi
List of Unique Device Identifiers associated with this line item. -
udiTarget
List<Device> udiTarget
The actual objects that are the target of the reference (List of Unique Device Identifiers associated with this line item.) -
unitPrice
Money unitPrice
If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.
-
-
Class org.hl7.fhir.dstu3.model.ExplanationOfBenefit.DiagnosisComponent
class DiagnosisComponent extends BackboneElement implements Serializable- serialVersionUID:
- -350960873L
-
Serialized Fields
-
diagnosis
Type diagnosis
The diagnosis. -
packageCode
CodeableConcept packageCode
The package billing code, for example DRG, based on the assigned grouping code system. -
sequence
PositiveIntType sequence
Sequence of diagnosis which serves to provide a link. -
type
List<CodeableConcept> type
The type of the Diagnosis, for example: admitting, primary, secondary, discharge.
-
-
Class org.hl7.fhir.dstu3.model.ExplanationOfBenefit.ExplanationOfBenefitStatusEnumFactory
class ExplanationOfBenefitStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.ExplanationOfBenefit.InsuranceComponent
class InsuranceComponent extends BackboneElement implements Serializable- serialVersionUID:
- -870298727L
-
Serialized Fields
-
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.) -
preAuthRef
List<StringType> preAuthRef
A list of references from the Insurer to which these services pertain.
-
-
Class org.hl7.fhir.dstu3.model.ExplanationOfBenefit.ItemComponent
class ItemComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1567825229L
-
Serialized Fields
-
adjudication
List<ExplanationOfBenefit.AdjudicationComponent> adjudication
The adjudications results. -
bodySite
CodeableConcept bodySite
Physical service site on the patient (limb, tooth, etc). -
careTeamLinkId
List<PositiveIntType> careTeamLinkId
Careteam applicable for this service or product line. -
category
CodeableConcept category
Health Care Service Type Codes to identify the classification of service or benefits. -
detail
List<ExplanationOfBenefit.DetailComponent> detail
Second tier of goods and services. -
diagnosisLinkId
List<PositiveIntType> diagnosisLinkId
Diagnosis applicable for this service or product line. -
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. -
informationLinkId
List<PositiveIntType> informationLinkId
Exceptions, special conditions and supporting information pplicable for this service or product line. -
location
Type location
Where the service was provided. -
modifier
List<CodeableConcept> modifier
Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours. -
net
Money net
The quantity times the unit price for an addittional service or product or charge. 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. -
noteNumber
List<PositiveIntType> noteNumber
A list of note references to the notes provided below. -
procedureLinkId
List<PositiveIntType> procedureLinkId
Procedures applicable for this service or product line. -
programCode
List<CodeableConcept> programCode
For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program. -
quantity
SimpleQuantity quantity
The number of repetitions of a service or product. -
revenue
CodeableConcept revenue
The type of reveneu or cost center providing the product and/or service. -
sequence
PositiveIntType sequence
A service line number. -
service
CodeableConcept service
If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. 'glasses' or 'compound'. -
serviced
Type serviced
The date or dates when the enclosed suite of services were performed or completed. -
subSite
List<CodeableConcept> subSite
A region or surface of the site, eg. limb region or tooth surface(s). -
udi
List<Reference> udi
List of Unique Device Identifiers associated with this line item. -
udiTarget
List<Device> udiTarget
The actual objects that are the target of the reference (List of Unique Device Identifiers associated with this line item.) -
unitPrice
Money unitPrice
If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.
-
-
Class org.hl7.fhir.dstu3.model.ExplanationOfBenefit.NoteComponent
class NoteComponent extends BackboneElement implements Serializable- serialVersionUID:
- -944255449L
-
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. -
number
PositiveIntType number
An integer associated with each note which may be referred to from each service line item. -
text
StringType text
The note text. -
type
CodeableConcept type
The note purpose: Print/Display.
-
-
Class org.hl7.fhir.dstu3.model.ExplanationOfBenefit.PayeeComponent
class PayeeComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1146157718L
-
Serialized Fields
-
party
Reference party
Party to be reimbursed: Subscriber, provider, other. -
partyTarget
Resource partyTarget
The actual object that is the target of the reference (Party to be reimbursed: Subscriber, provider, other.) -
resourceType
CodeableConcept resourceType
organization | patient | practitioner | relatedperson. -
type
CodeableConcept type
Type of Party to be reimbursed: Subscriber, provider, other.
-
-
Class org.hl7.fhir.dstu3.model.ExplanationOfBenefit.PaymentComponent
class PaymentComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1539906026L
-
Serialized Fields
-
adjustment
Money adjustment
Adjustment to the payment of this transaction which is not related to adjudication of this transaction. -
adjustmentReason
CodeableConcept adjustmentReason
Reason for the payment adjustment. -
amount
Money amount
Payable less any payment adjustment. -
date
DateType date
Estimated payment date. -
identifier
Identifier identifier
Payment identifer. -
type
CodeableConcept type
Whether this represents partial or complete payment of the claim.
-
-
Class org.hl7.fhir.dstu3.model.ExplanationOfBenefit.ProcedureComponent
class ProcedureComponent extends BackboneElement implements Serializable- serialVersionUID:
- 864307347L
-
Serialized Fields
-
date
DateTimeType date
Date and optionally time the procedure was performed . -
procedure
Type procedure
The procedure code. -
sequence
PositiveIntType sequence
Sequence of procedures which serves to order and provide a link.
-
-
Class org.hl7.fhir.dstu3.model.ExplanationOfBenefit.RelatedClaimComponent
class RelatedClaimComponent extends BackboneElement implements Serializable- serialVersionUID:
- -379338905L
-
Serialized Fields
-
claim
Reference claim
Other claims which are related to this claim such as prior claim versions or for related services. -
claimTarget
Claim claimTarget
The actual object that is the target of the reference (Other claims which are related to this claim such as prior claim versions or for related services.) -
reference
Identifier reference
An alternate organizational reference to the case or file to which this particular claim pertains - eg Property/Casualy insurer claim # or Workers Compensation case # . -
relationship
CodeableConcept relationship
For example prior or umbrella.
-
-
Class org.hl7.fhir.dstu3.model.ExplanationOfBenefit.SubDetailComponent
class SubDetailComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1621872130L
-
Serialized Fields
-
adjudication
List<ExplanationOfBenefit.AdjudicationComponent> adjudication
The adjudications results. -
category
CodeableConcept category
Health Care Service Type Codes to identify the classification of service or benefits. -
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, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours. -
net
Money net
The quantity times the unit price for an addittional service or product or charge. 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. -
noteNumber
List<PositiveIntType> noteNumber
A list of note references to the notes provided below. -
programCode
List<CodeableConcept> programCode
For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program. -
quantity
SimpleQuantity quantity
The number of repetitions of a service or product. -
revenue
CodeableConcept revenue
The type of reveneu or cost center providing the product and/or service. -
sequence
PositiveIntType sequence
A service line number. -
service
CodeableConcept service
A code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). -
type
CodeableConcept type
The type of product or service. -
udi
List<Reference> udi
List of Unique Device Identifiers associated with this line item. -
udiTarget
List<Device> udiTarget
The actual objects that are the target of the reference (List of Unique Device Identifiers associated with this line item.) -
unitPrice
Money unitPrice
The fee for an addittional service or product or charge.
-
-
Class org.hl7.fhir.dstu3.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 which may influence the adjudication. -
reason
Coding reason
For example, provides the reason for: the additional stay, or missing tooth or any other situation where a reason code is required in addition to the content. -
sequence
PositiveIntType sequence
Sequence of the information element which serves to provide a link. -
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.dstu3.model.Extension
class Extension extends BaseExtension implements Serializable- serialVersionUID:
- 1240831878L
-
Class org.hl7.fhir.dstu3.model.FamilyMemberHistory
class FamilyMemberHistory extends DomainResource implements Serializable- serialVersionUID:
- 388742645L
-
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. -
date
DateTimeType date
The date (and possibly time) when the family member history was taken. -
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. -
definition
List<Reference> definition
A protocol or questionnaire that was adhered to in whole or in part by this event. -
definitionTarget
List<Resource> definitionTarget
The actual objects that are the target of the reference (A protocol or questionnaire that was adhered to in whole or in part by this event.) -
estimatedAge
BooleanType estimatedAge
If true, indicates that the age value specified is an estimated value. -
gender
Enumeration<Enumerations.AdministrativeGender> gender
Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes. -
identifier
List<Identifier> identifier
This records identifiers associated with this family member history record 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). -
name
StringType name
This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair". -
notDone
BooleanType notDone
If true, indicates the taking of an individual family member's history did not occur. The notDone element should not be used to document negated conditions, such as a family member that did not have a condition. -
notDoneReason
CodeableConcept notDoneReason
Describes why the family member's history is absent. -
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.). -
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.dstu3.model.FamilyMemberHistory.FamilyHistoryStatusEnumFactory
class FamilyHistoryStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.FamilyMemberHistory.FamilyMemberHistoryConditionComponent
class FamilyMemberHistoryConditionComponent extends BackboneElement implements Serializable- serialVersionUID:
- 598309281L
-
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. -
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 as a result of this condition. If the condition resulted in death, deceased date is captured on the relation.
-
-
Class org.hl7.fhir.dstu3.model.Flag
class Flag extends DomainResource implements Serializable- serialVersionUID:
- -619061399L
-
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
CodeableConcept category
Allows an 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
Identifier assigned to the flag for external use (outside the FHIR environment). -
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.dstu3.model.Flag.FlagStatusEnumFactory
class FlagStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.Goal
class Goal extends DomainResource implements Serializable- serialVersionUID:
- -1045412647L
-
Serialized Fields
-
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
This records identifiers associated with this care plan 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). -
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. -
status
Enumeration<Goal.GoalStatus> status
Indicates whether the goal has been reached and is still considered relevant. -
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
Goal.GoalTargetComponent target
Indicates what should be done by when.
-
-
Class org.hl7.fhir.dstu3.model.Goal.GoalStatusEnumFactory
class GoalStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.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.dstu3.model.GraphDefinition
class GraphDefinition extends MetadataResource implements Serializable- serialVersionUID:
- 86877575L
-
Serialized Fields
-
link
List<GraphDefinition.GraphDefinitionLinkComponent> link
Links this graph makes rules about. -
profile
UriType profile
The profile that describes the use of the base resource. -
purpose
MarkdownType purpose
Explaination 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.dstu3.model.GraphDefinition.CompartmentCodeEnumFactory
class CompartmentCodeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.model.GraphDefinition.GraphCompartmentRuleEnumFactory
class GraphCompartmentRuleEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu3.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
Path in the resource that contains the link. -
sliceName
StringType sliceName
Which slice (if profiled). -
target
List<GraphDefinition.GraphDefinitionLinkTargetComponent> target
Potential target for the link.
-
-
Class org.hl7.fhir.dstu3.model.GraphDefinition.GraphDefinitionLinkTargetCompartmentComponent
class GraphDefinitionLinkTargetCompartmentComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1046660576L
-
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.
-
-
Class org.hl7.fhir.dstu3.model.GraphDefinition.GraphDefinitionLinkTargetComponent
class GraphDefinitionLinkTargetComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1862411341L
-
Serialized Fields
-
compartment
List<GraphDefinition.GraphDefinitionLinkTargetCompartmentComponent> compartment
Compartment Consistency Rules. -
link
List<GraphDefinition.GraphDefinitionLinkComponent> link
Additional links from target resource. -
profile
UriType profile
Profile for the target resource. -
type
CodeType type
Type of resource this link refers to.
-
-
Class org.hl7.fhir.dstu3.model.Group
class Group extends DomainResource implements Serializable- serialVersionUID:
- 659980713L
-
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 the traits 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. -
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.dstu3.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 gro
-
-