Serialized Form
-
Package org.hl7.fhir.dstu2.model
-
Class org.hl7.fhir.dstu2.model.Account
class Account extends DomainResource implements Serializable- serialVersionUID:
- -1926153194L
-
Serialized Fields
-
activePeriod
Period activePeriod
Indicates the period of time over which the account is allowed. -
balance
Money balance
Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negative. -
coveragePeriod
Period coveragePeriod
Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc. -
currency
Coding currency
Identifies the currency to which transactions must be converted when crediting or debiting the account. -
description
StringType description
Provides additional information about what the account tracks and how it is used. -
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.) -
status
Enumeration<Account.AccountStatus> status
Indicates whether the account is presently used/useable 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.dstu2.model.Account.AccountStatusEnumFactory
class AccountStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.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.dstu2.model.Address.AddressTypeEnumFactory
class AddressTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Address.AddressUseEnumFactory
class AddressUseEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Age
class Age extends Quantity implements Serializable- serialVersionUID:
- 1069574054L
-
Class org.hl7.fhir.dstu2.model.AllergyIntolerance
class AllergyIntolerance extends DomainResource implements Serializable- serialVersionUID:
- -1657522921L
-
Serialized Fields
-
category
Enumeration<AllergyIntolerance.AllergyIntoleranceCategory> category
Category of the identified Substance. -
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). -
lastOccurence
DateTimeType lastOccurence
Represents the date and/or time of the last known occurrence of a reaction event. -
note
Annotation note
Additional narrative about the propensity for the Adverse Reaction, not captured in other fields. -
onset
DateTimeType onset
Record of the date and/or time of the onset of the Allergy or Intolerance. -
patient
Reference patient
The patient who has the allergy or intolerance. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (The patient who has the allergy or intolerance.) -
reaction
List<AllergyIntolerance.AllergyIntoleranceReactionComponent> reaction
Details about each adverse reaction event linked to exposure to the identified Substance. -
recordedDate
DateTimeType recordedDate
Date when the sensitivity was recorded. -
recorder
Reference recorder
Individual who recorded the record and takes responsibility for its conten. -
recorderTarget
Resource recorderTarget
The actual object that is the target of the reference (Individual who recorded the record and takes responsibility for its conten.) -
reporter
Reference reporter
The source of the information about the allergy that is recorded. -
reporterTarget
Resource reporterTarget
The actual object that is the target of the reference (The source of the information about the allergy that is recorded.) -
status
Enumeration<AllergyIntolerance.AllergyIntoleranceStatus> status
Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified Substance. -
substance
CodeableConcept substance
Identification of a substance, or a class of substances, that is considered to be responsible for the adverse reaction risk. -
type
Enumeration<AllergyIntolerance.AllergyIntoleranceType> type
Identification of the underlying physiological mechanism for the reaction risk.
-
-
Class org.hl7.fhir.dstu2.model.AllergyIntolerance.AllergyIntoleranceCategoryEnumFactory
class AllergyIntoleranceCategoryEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.AllergyIntolerance.AllergyIntoleranceCertaintyEnumFactory
class AllergyIntoleranceCertaintyEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.AllergyIntolerance.AllergyIntoleranceCriticalityEnumFactory
class AllergyIntoleranceCriticalityEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.AllergyIntolerance.AllergyIntoleranceReactionComponent
class AllergyIntoleranceReactionComponent extends BackboneElement implements Serializable- serialVersionUID:
- -765664367L
-
Serialized Fields
-
certainty
Enumeration<AllergyIntolerance.AllergyIntoleranceCertainty> certainty
Statement about the degree of clinical certainty that the specific substance was the cause of the manifestation in this reaction event. -
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
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 considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different to the substance identified as the cause of the risk, but must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite substance that includes the identified substance. It must be clinically safe to only process the AllergyIntolerance.substance and ignore the AllergyIntolerance.event.substance.
-
-
Class org.hl7.fhir.dstu2.model.AllergyIntolerance.AllergyIntoleranceSeverityEnumFactory
class AllergyIntoleranceSeverityEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.AllergyIntolerance.AllergyIntoleranceStatusEnumFactory
class AllergyIntoleranceStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.AllergyIntolerance.AllergyIntoleranceTypeEnumFactory
class AllergyIntoleranceTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.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.dstu2.model.Appointment
class Appointment extends DomainResource implements Serializable- serialVersionUID:
- -1403944125L
-
Serialized Fields
-
comment
StringType comment
Additional comments about the appointment. -
description
StringType description
The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field. -
end
InstantType end
Date/Time that the appointment is to conclude. -
identifier
List<Identifier> identifier
This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). -
minutesDuration
PositiveIntType minutesDuration
Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (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
CodeableConcept reason
The reason that this appointment is being scheduled. This is more clinical than administrative. -
slot
List<Reference> slot
The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot. -
slotTarget
List<Slot> slotTarget
The actual objects that are the target of the reference (The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot.) -
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. -
type
CodeableConcept type
The type of appointment that is being booked (This may also be associated with participants for location, and/or a HealthcareService).
-
-
Class org.hl7.fhir.dstu2.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 Patient. -
type
List<CodeableConcept> type
Role of participant in the appointment.
-
-
Class org.hl7.fhir.dstu2.model.Appointment.AppointmentStatusEnumFactory
class AppointmentStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Appointment.ParticipantRequiredEnumFactory
class ParticipantRequiredEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Appointment.ParticipationStatusEnumFactory
class ParticipationStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.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.dstu2.model.AppointmentResponse.ParticipantStatusEnumFactory
class ParticipantStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.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. -
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.dstu2.model.AuditEvent
class AuditEvent extends DomainResource implements Serializable- serialVersionUID:
- -1495151000L
-
Serialized Fields
-
event
AuditEvent.AuditEventEventComponent event
Identifies the name, action type, time, and disposition of the audited event. -
object
List<AuditEvent.AuditEventObjectComponent> object
Specific instances of data or objects that have been accessed. -
participant
List<AuditEvent.AuditEventParticipantComponent> participant
A person, a hardware device or software process. -
source
AuditEvent.AuditEventSourceComponent source
Application systems and processes.
-
-
Class org.hl7.fhir.dstu2.model.AuditEvent.AuditEventActionEnumFactory
class AuditEventActionEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.AuditEvent.AuditEventEventComponent
class AuditEventEventComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1916806397L
-
Serialized Fields
-
action
Enumeration<AuditEvent.AuditEventAction> action
Indicator for type of action performed during the event that generated the audit. -
dateTime
InstantType dateTime
The time when the event occurred on the source. -
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<Coding> purposeOfEvent
The purposeOfUse (reason) that was used during the event being recorded. -
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.dstu2.model.AuditEvent.AuditEventObjectComponent
class AuditEventObjectComponent extends BackboneElement implements Serializable- serialVersionUID:
- 997591908L
-
Serialized Fields
-
description
StringType description
Text that describes the object in more detail. -
detail
List<AuditEvent.AuditEventObjectDetailComponent> detail
Additional Information about the Object. -
identifier
Identifier identifier
Identifies a specific instance of the participant object. The reference should always be version specific. -
lifecycle
Coding lifecycle
Identifier for the data life-cycle stage for the participant object. -
name
StringType name
An instance-specific descriptor of the Participant Object ID audited, such as a person's name. -
query
Base64BinaryType query
The actual query for a query-type participant object. -
reference
Reference reference
Identifies a specific instance of the participant object. The reference should always be version specific. -
referenceTarget
Resource referenceTarget
The actual object that is the target of the reference (Identifies a specific instance of the participant object. The reference should always be version specific.) -
role
Coding role
Code representing the functional application role of Participant Object being audited. -
securityLabel
List<Coding> securityLabel
Denotes security labels for the identified object. -
type
Coding type
The type of the object that was involved in this audit event.
-
-
Class org.hl7.fhir.dstu2.model.AuditEvent.AuditEventObjectDetailComponent
class AuditEventObjectDetailComponent extends BackboneElement implements Serializable- serialVersionUID:
- 11139504L
-
Serialized Fields
-
type
StringType type
Name of the property. -
value
Base64BinaryType value
Property value.
-
-
Class org.hl7.fhir.dstu2.model.AuditEvent.AuditEventOutcomeEnumFactory
class AuditEventOutcomeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.AuditEvent.AuditEventParticipantComponent
class AuditEventParticipantComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1783296995L
-
Serialized Fields
-
altId
StringType altId
Alternative Participant 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 user. -
network
AuditEvent.AuditEventParticipantNetworkComponent 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<Coding> purposeOfUse
The reason (purpose of use), specific to this participant, that was used during the event being recorded. -
reference
Reference reference
Direct reference to a resource that identifies the participant. -
referenceTarget
Resource referenceTarget
The actual object that is the target of the reference (Direct reference to a resource that identifies the participant.) -
requestor
BooleanType requestor
Indicator that the user is or is not the requestor, or initiator, for the event being audited. -
role
List<CodeableConcept> role
Specification of the role(s) the user plays when performing the event. Usually the codes used in this element are local codes defined by the role-based access control security system used in the local context. -
userId
Identifier userId
Unique identifier for the user actively participating in the event.
-
-
Class org.hl7.fhir.dstu2.model.AuditEvent.AuditEventParticipantNetworkComponent
class AuditEventParticipantNetworkComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1355220390L
-
Serialized Fields
-
address
StringType address
An identifier for the network access point of the user device for the audit event. -
type
Enumeration<AuditEvent.AuditEventParticipantNetworkType> type
An identifier for the type of network access point that originated the audit event.
-
-
Class org.hl7.fhir.dstu2.model.AuditEvent.AuditEventParticipantNetworkTypeEnumFactory
class AuditEventParticipantNetworkTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.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.dstu2.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.dstu2.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.dstu2.model.Base64BinaryType
class Base64BinaryType extends PrimitiveType<byte[]> implements Serializable- serialVersionUID:
- 3L
-
Class org.hl7.fhir.dstu2.model.BaseBinary
class BaseBinary extends Resource implements Serializable -
Class org.hl7.fhir.dstu2.model.BaseDateTimeType
- serialVersionUID:
- 1L
-
Serialized Fields
-
myPrecision
ca.uhn.fhir.model.api.TemporalPrecisionEnum myPrecision
-
myTimeZone
TimeZone myTimeZone
-
myTimeZoneZulu
boolean myTimeZoneZulu
-
-
Class org.hl7.fhir.dstu2.model.BaseExtension
class BaseExtension extends Type implements Serializable -
Class org.hl7.fhir.dstu2.model.BaseNarrative
class BaseNarrative extends Type implements Serializable -
Class org.hl7.fhir.dstu2.model.BaseReference
class BaseReference extends Type implements Serializable -
Class org.hl7.fhir.dstu2.model.BaseResource
class BaseResource extends Base implements Serializable- serialVersionUID:
- 1L
-
Class org.hl7.fhir.dstu2.model.Basic
class Basic extends DomainResource implements Serializable- serialVersionUID:
- 916539354L
-
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.dstu2.model.Binary
class Binary extends BaseBinary implements Serializable- serialVersionUID:
- 974764407L
-
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).
-
-
Class org.hl7.fhir.dstu2.model.BodySite
class BodySite extends DomainResource implements Serializable- serialVersionUID:
- 1568109920L
-
Serialized Fields
-
code
CodeableConcept code
Named anatomical location - ideally coded where possible. -
description
StringType description
Description of anatomical 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. -
modifier
List<CodeableConcept> modifier
Modifier to refine the anatomical location. These include modifiers for laterality, relative location, directionality, number, and plane. -
patient
Reference patient
The person to which the body site belongs. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (The person to which the body site belongs.)
-
-
Class org.hl7.fhir.dstu2.model.BooleanType
- serialVersionUID:
- 3L
-
Class org.hl7.fhir.dstu2.model.Bundle
class Bundle extends Resource implements Serializable- serialVersionUID:
- -2041954721L
-
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). -
link
List<Bundle.BundleLinkComponent> link
A series of links that provide context to this bundle. -
signature
Signature signature
Digital Signature - base64 encoded. XML DigSIg 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.dstu2.model.Bundle.BundleEntryComponent
class BundleEntryComponent extends BackboneElement implements Serializable- serialVersionUID:
- 517783054L
-
Serialized Fields
-
fullUrl
UriType fullUrl
The Absolute URL for the resource. This must be provided for all resources. The fullUrl SHALL not disagree with the id in the resource. The fullUrl is a version independent reference to the resource. -
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.dstu2.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 update 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.dstu2.model.Bundle.BundleEntryResponseComponent
class BundleEntryResponseComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1526413234L
-
Serialized Fields
-
etag
StringType etag
The etag for the resource, it the operation for the entry produced a versioned resource. -
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. -
status
StringType status
The status code returned by processing this entry.
-
-
Class org.hl7.fhir.dstu2.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.dstu2.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]]. -
url
UriType url
The reference details for the link.
-
-
Class org.hl7.fhir.dstu2.model.Bundle.BundleTypeEnumFactory
class BundleTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Bundle.HTTPVerbEnumFactory
class HTTPVerbEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Bundle.SearchEntryModeEnumFactory
class SearchEntryModeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.CarePlan
class CarePlan extends DomainResource implements Serializable- serialVersionUID:
- -307500543L
-
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.) -
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 context in which this particular CarePlan is defined. -
contextTarget
Resource contextTarget
The actual object that is the target of the reference (Identifies the context in which this particular CarePlan is defined.) -
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). -
modified
DateTimeType modified
Identifies the most recent date on which the plan has been revised. -
note
Annotation note
General notes about the care plan not covered elsewhere. -
participant
List<CarePlan.CarePlanParticipantComponent> participant
Identifies all people and organizations who are expected to be involved in the care envisioned by this plan. -
period
Period period
Indicates when the plan did (or is intended to) come into effect and end. -
relatedPlan
List<CarePlan.CarePlanRelatedPlanComponent> relatedPlan
Identifies CarePlans with some sort of formal relationship to the current 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.) -
support
List<Reference> support
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. -
supportTarget
List<Resource> supportTarget
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.)
-
-
Class org.hl7.fhir.dstu2.model.CarePlan.CarePlanActivityComponent
class CarePlanActivityComponent extends BackboneElement implements Serializable- serialVersionUID:
- 40181608L
-
Serialized Fields
-
actionResulting
List<Reference> actionResulting
Resources that describe follow-on actions resulting from the plan, such as drug prescriptions, encounter records, appointments, etc. -
actionResultingTarget
List<Resource> actionResultingTarget
The actual objects that are the target of the reference (Resources that describe follow-on actions resulting from the plan, such as drug prescriptions, encounter records, appointments, etc.) -
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. -
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.dstu2.model.CarePlan.CarePlanActivityDetailComponent
class CarePlanActivityDetailComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1763965702L
-
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. -
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. -
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. -
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
CodeableConcept statusReason
Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.
-
-
Class org.hl7.fhir.dstu2.model.CarePlan.CarePlanActivityStatusEnumFactory
class CarePlanActivityStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.CarePlan.CarePlanParticipantComponent
class CarePlanParticipantComponent extends BackboneElement implements Serializable- serialVersionUID:
- -466811117L
-
Serialized Fields
-
member
Reference member
The specific person or organization who is participating/expected to participate in the care plan. -
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 plan.) -
role
CodeableConcept role
Indicates specific responsibility of an individual within the care plan; e.g. "Primary physician", "Team coordinator", "Caregiver", etc.
-
-
Class org.hl7.fhir.dstu2.model.CarePlan.CarePlanRelatedPlanComponent
class CarePlanRelatedPlanComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1875598050L
-
Serialized Fields
-
code
Enumeration<CarePlan.CarePlanRelationship> code
Identifies the type of relationship this plan has to the target plan. -
plan
Reference plan
A reference to the plan to which a relationship is asserted. -
planTarget
CarePlan planTarget
The actual object that is the target of the reference (A reference to the plan to which a relationship is asserted.)
-
-
Class org.hl7.fhir.dstu2.model.CarePlan.CarePlanRelationshipEnumFactory
class CarePlanRelationshipEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.CarePlan.CarePlanStatusEnumFactory
class CarePlanStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Claim
class Claim extends DomainResource implements Serializable- serialVersionUID:
- 4272227L
-
Serialized Fields
-
accident
DateType accident
Date of an accident which these services are addressing. -
accidentType
Coding accidentType
Type of accident: work, auto, etc. -
additionalMaterials
List<Coding> additionalMaterials
Code to indicate that Xrays, images, emails, documents, models or attachments are being sent in support of this submission. -
condition
List<Coding> condition
List of patient conditions for which care is sought. -
coverage
List<Claim.CoverageComponent> coverage
Financial instrument by which payment information for health care. -
created
DateTimeType created
The date when the enclosed suite of services were performed or completed. -
diagnosis
List<Claim.DiagnosisComponent> diagnosis
Ordered list of patient diagnosis for which care is sought. -
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.) -
exception
List<Coding> exception
Factors which may influence the applicability of coverage. -
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
Coding 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. -
identifier
List<Identifier> identifier
The business identifier for the instance: invoice number, claim number, pre-determination or pre-authorization number. -
interventionException
List<Coding> interventionException
A list of intervention and exception codes which may influence the adjudication of the claim. -
item
List<Claim.ItemsComponent> item
First tier of goods and services. -
missingTeeth
List<Claim.MissingTeethComponent> missingTeeth
A list of teeth which would be expected but are not found due to having been previously extracted or for other reasons. -
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 to support the dispensing of pharmacy services, medications or products. -
originalPrescriptionTarget
MedicationOrder originalPrescriptionTarget
The actual object that is the target of the reference (Original prescription to support the dispensing of pharmacy services, medications or products.) -
originalRuleset
Coding originalRuleset
The version of the specification from which the original instance was created. -
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
Coding priority
Immediate (stat), best effort (normal), deferred (deferred). -
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.) -
ruleset
Coding ruleset
The version of the specification on which this instance relies. -
school
StringType school
Name of school for over-aged dependents. -
target
Reference target
Insurer Identifier, typical BIN number (6 digit). -
targetTarget
Organization targetTarget
The actual object that is the target of the reference (Insurer Identifier, typical BIN number (6 digit).) -
type
Enumeration<Claim.ClaimType> type
The category of claim this is. -
use
Enumeration<Claim.Use> use
Complete (Bill or Claim), Proposed (Pre-Authorization), Exploratory (Pre-determination).
-
-
Class org.hl7.fhir.dstu2.model.Claim.ClaimTypeEnumFactory
class ClaimTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Claim.CoverageComponent
class CoverageComponent extends BackboneElement implements Serializable- serialVersionUID:
- 621250924L
-
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. -
originalRuleset
Coding originalRuleset
The style (standard) and version of the original material which was converted into this resource. -
preAuthRef
List<StringType> preAuthRef
A list of references from the Insurer to which these services pertain. -
relationship
Coding relationship
The relationship of the patient to the subscriber. -
sequence
PositiveIntType sequence
A service line item.
-
-
Class org.hl7.fhir.dstu2.model.Claim.DetailComponent
class DetailComponent extends BackboneElement implements Serializable- serialVersionUID:
- 5768017L
-
Serialized Fields
-
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. -
net
Money net
The quantity times the unit price for an additional 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. -
points
DecimalType points
An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point. -
quantity
SimpleQuantity quantity
The number of repetitions of a service or product. -
sequence
PositiveIntType sequence
A service line number. -
service
Coding service
If a grouping item then 'GROUP' otherwise it is a node therefore a code to indicate the Professional Service or Product supplied. -
subDetail
List<Claim.SubDetailComponent> subDetail
Third tier of goods and services. -
type
Coding type
The type of product or service. -
udi
Coding udi
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.dstu2.model.Claim.DiagnosisComponent
class DiagnosisComponent extends BackboneElement implements Serializable- serialVersionUID:
- -795010186L
-
Serialized Fields
-
diagnosis
Coding diagnosis
The diagnosis. -
sequence
PositiveIntType sequence
Sequence of diagnosis which serves to order and provide a link.
-
-
Class org.hl7.fhir.dstu2.model.Claim.ItemsComponent
class ItemsComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1295830456L
-
Serialized Fields
-
bodySite
Coding bodySite
Physical service site on the patient (limb, tooth, etc.). -
detail
List<Claim.DetailComponent> detail
Second tier of goods and services. -
diagnosisLinkId
List<PositiveIntType> diagnosisLinkId
Diagnosis applicable for this service or product line. -
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<Coding> modifier
Item typification or modifiers codes, e.g. for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. -
net
Money net
The quantity times the unit price for an additional 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. -
points
DecimalType points
An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point. -
prosthesis
Claim.ProsthesisComponent prosthesis
The materials and placement date of prior fixed prosthesis. -
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.) -
quantity
SimpleQuantity quantity
The number of repetitions of a service or product. -
sequence
PositiveIntType sequence
A service line number. -
service
Coding service
If a grouping item then 'GROUP' otherwise it is a node therefore a code to indicate the Professional Service or Product supplied. -
serviceDate
DateType serviceDate
The date when the enclosed suite of services were performed or completed. -
subSite
List<Coding> subSite
A region or surface of the site, e.g. limb region or tooth surface(s). -
type
Coding type
The type of product or service. -
udi
Coding udi
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.dstu2.model.Claim.MissingTeethComponent
class MissingTeethComponent extends BackboneElement implements Serializable- serialVersionUID:
- 352913313L
-
Class org.hl7.fhir.dstu2.model.Claim.PayeeComponent
class PayeeComponent extends BackboneElement implements Serializable- serialVersionUID:
- -503108488L
-
Serialized Fields
-
organization
Reference organization
The organization who is to be reimbursed for the claim (the party to whom any benefit is assigned). -
organizationTarget
Organization organizationTarget
The actual object that is the target of the reference (The organization who is to be reimbursed for the claim (the party to whom any benefit is assigned).) -
person
Reference person
The person other than the subscriber who is to be reimbursed for the claim (the party to whom any benefit is assigned). -
personTarget
Patient personTarget
The actual object that is the target of the reference (The person other than the subscriber who is to be reimbursed for the claim (the party to whom any benefit is assigned).) -
provider
Reference provider
The provider who is to be reimbursed for the claim (the party to whom any benefit is assigned). -
providerTarget
Practitioner providerTarget
The actual object that is the target of the reference (The provider who is to be reimbursed for the claim (the party to whom any benefit is assigned).) -
type
Coding type
Party to be reimbursed: Subscriber, provider, other.
-
-
Class org.hl7.fhir.dstu2.model.Claim.ProsthesisComponent
class ProsthesisComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1739349641L
-
Serialized Fields
-
initial
BooleanType initial
Indicates whether this is the initial placement of a fixed prosthesis. -
priorDate
DateType priorDate
Date of the initial placement. -
priorMaterial
Coding priorMaterial
Material of the prior denture or bridge prosthesis. (Oral).
-
-
Class org.hl7.fhir.dstu2.model.Claim.SubDetailComponent
class SubDetailComponent extends BackboneElement implements Serializable- serialVersionUID:
- 623567568L
-
Serialized Fields
-
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. -
net
Money net
The quantity times the unit price for an additional 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. -
points
DecimalType points
An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point. -
quantity
SimpleQuantity quantity
The number of repetitions of a service or product. -
sequence
PositiveIntType sequence
A service line number. -
service
Coding service
The fee for an additional service or product or charge. -
type
Coding type
The type of product or service. -
udi
Coding udi
List of Unique Device Identifiers associated with this line item. -
unitPrice
Money unitPrice
The fee for an additional service or product or charge.
-
-
Class org.hl7.fhir.dstu2.model.Claim.UseEnumFactory
class UseEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.ClaimResponse
class ClaimResponse extends DomainResource implements Serializable- serialVersionUID:
- 2021598689L
-
Serialized Fields
-
addItem
List<ClaimResponse.AddedItemComponent> addItem
The first tier service adjudications for payor added services. -
coverage
List<ClaimResponse.CoverageComponent> coverage
Financial instrument by which payment information for health care. -
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.ErrorsComponent> error
Mutually exclusive with Services Provided (Item). -
form
Coding form
The form to be used for printing the content. -
identifier
List<Identifier> identifier
The Response business identifier. -
item
List<ClaimResponse.ItemsComponent> item
The first tier service adjudications for submitted services. -
note
List<ClaimResponse.NotesComponent> note
Note text. -
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.) -
originalRuleset
Coding originalRuleset
The style (standard) and version of the original material which was converted into this resource. -
outcome
Enumeration<Enumerations.RemittanceOutcome> outcome
Transaction status: error, complete. -
payeeType
Coding payeeType
Party to be reimbursed: Subscriber, provider, other. -
paymentAdjustment
Money paymentAdjustment
Adjustment to the payment of this transaction which is not related to adjudication of this transaction. -
paymentAdjustmentReason
Coding paymentAdjustmentReason
Reason for the payment adjustment. -
paymentAmount
Money paymentAmount
Payable less any payment adjustment. -
paymentDate
DateType paymentDate
Estimated payment data. -
paymentRef
Identifier paymentRef
Payment identifier. -
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). -
ruleset
Coding ruleset
The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources. -
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.dstu2.model.ClaimResponse.AddedItemAdjudicationComponent
class AddedItemAdjudicationComponent extends BackboneElement implements Serializable- serialVersionUID:
- -949880587L
-
Serialized Fields
-
amount
Money amount
Monetary amount associated with the code. -
code
Coding code
Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc. -
value
DecimalType value
A non-monetary value for example a percentage. Mutually exclusive to the amount element above.
-
-
Class org.hl7.fhir.dstu2.model.ClaimResponse.AddedItemComponent
class AddedItemComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1675935854L
-
Serialized Fields
-
adjudication
List<ClaimResponse.AddedItemAdjudicationComponent> adjudication
The adjudications results. -
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.. -
noteNumberLinkId
List<PositiveIntType> noteNumberLinkId
A list of note references to the notes provided below. -
sequenceLinkId
List<PositiveIntType> sequenceLinkId
List of input service items which this service line is intended to replace. -
service
Coding service
A code to indicate the Professional Service or Product supplied.
-
-
Class org.hl7.fhir.dstu2.model.ClaimResponse.AddedItemDetailAdjudicationComponent
class AddedItemDetailAdjudicationComponent extends BackboneElement implements Serializable- serialVersionUID:
- -949880587L
-
Serialized Fields
-
amount
Money amount
Monetary amount associated with the code. -
code
Coding code
Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc. -
value
DecimalType value
A non-monetary value for example a percentage. Mutually exclusive to the amount element above.
-
-
Class org.hl7.fhir.dstu2.model.ClaimResponse.AddedItemsDetailComponent
class AddedItemsDetailComponent extends BackboneElement implements Serializable- serialVersionUID:
- -2104242020L
-
Serialized Fields
-
adjudication
List<ClaimResponse.AddedItemDetailAdjudicationComponent> adjudication
The adjudications results. -
fee
Money fee
The fee charged for the professional service or product.. -
service
Coding service
A code to indicate the Professional Service or Product supplied.
-
-
Class org.hl7.fhir.dstu2.model.ClaimResponse.CoverageComponent
class CoverageComponent extends BackboneElement implements Serializable- serialVersionUID:
- 621250924L
-
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. -
originalRuleset
Coding originalRuleset
The style (standard) and version of the original material which was converted into this resource. -
preAuthRef
List<StringType> preAuthRef
A list of references from the Insurer to which these services pertain. -
relationship
Coding relationship
The relationship of the patient to the subscriber. -
sequence
PositiveIntType sequence
A service line item.
-
-
Class org.hl7.fhir.dstu2.model.ClaimResponse.DetailAdjudicationComponent
class DetailAdjudicationComponent extends BackboneElement implements Serializable- serialVersionUID:
- -949880587L
-
Serialized Fields
-
amount
Money amount
Monetary amount associated with the code. -
code
Coding code
Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc. -
value
DecimalType value
A non-monetary value for example a percentage. Mutually exclusive to the amount element above.
-
-
Class org.hl7.fhir.dstu2.model.ClaimResponse.ErrorsComponent
class ErrorsComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1893641175L
-
Serialized Fields
-
code
Coding code
An error code,froma 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.dstu2.model.ClaimResponse.ItemAdjudicationComponent
class ItemAdjudicationComponent extends BackboneElement implements Serializable- serialVersionUID:
- -949880587L
-
Serialized Fields
-
amount
Money amount
Monetary amount associated with the code. -
code
Coding code
Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc. -
value
DecimalType value
A non-monetary value for example a percentage. Mutually exclusive to the amount element above.
-
-
Class org.hl7.fhir.dstu2.model.ClaimResponse.ItemDetailComponent
class ItemDetailComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1751018357L
-
Serialized Fields
-
adjudication
List<ClaimResponse.DetailAdjudicationComponent> adjudication
The adjudications results. -
sequenceLinkId
PositiveIntType sequenceLinkId
A service line number. -
subDetail
List<ClaimResponse.SubDetailComponent> subDetail
The third tier service adjudications for submitted services.
-
-
Class org.hl7.fhir.dstu2.model.ClaimResponse.ItemsComponent
class ItemsComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1917866697L
-
Serialized Fields
-
adjudication
List<ClaimResponse.ItemAdjudicationComponent> adjudication
The adjudications 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.dstu2.model.ClaimResponse.NotesComponent
class NotesComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1768923951L
-
Serialized Fields
-
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
Coding type
The note purpose: Print/Display.
-
-
Class org.hl7.fhir.dstu2.model.ClaimResponse.SubdetailAdjudicationComponent
class SubdetailAdjudicationComponent extends BackboneElement implements Serializable- serialVersionUID:
- -949880587L
-
Serialized Fields
-
amount
Money amount
Monetary amount associated with the code. -
code
Coding code
Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc. -
value
DecimalType value
A non-monetary value for example a percentage. Mutually exclusive to the amount element above.
-
-
Class org.hl7.fhir.dstu2.model.ClaimResponse.SubDetailComponent
class SubDetailComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1780202110L
-
Serialized Fields
-
adjudication
List<ClaimResponse.SubdetailAdjudicationComponent> adjudication
The adjudications results. -
sequenceLinkId
PositiveIntType sequenceLinkId
A service line number.
-
-
Class org.hl7.fhir.dstu2.model.ClinicalImpression
class ClinicalImpression extends DomainResource implements Serializable- serialVersionUID:
- 1650458630L
-
Serialized Fields
-
action
List<Reference> action
Actions taken during assessment. -
actionTarget
List<Resource> actionTarget
The actual objects that are the target of the reference (Actions taken during assessment.) -
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.) -
date
DateTimeType date
The point in time at which the assessment was concluded (not when it was recorded). -
description
StringType description
A summary of the context and/or cause of the assessment - why / where was it peformed, and what patient events/sstatus prompted it. -
finding
List<ClinicalImpression.ClinicalImpressionFindingComponent> finding
Specific findings or diagnoses that was considered likely or relevant to ongoing treatment. -
investigations
List<ClinicalImpression.ClinicalImpressionInvestigationsComponent> investigations
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. -
patient
Reference patient
The patient being assessed. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (The patient being assessed.) -
plan
List<Reference> plan
Plan of action after assessment. -
planTarget
List<Resource> planTarget
The actual objects that are the target of the reference (Plan of action after assessment.) -
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 general problems/conditions for a patient. -
problemTarget
List<Resource> problemTarget
The actual objects that are the target of the reference (This a list of the general problems/conditions for a patient.) -
prognosis
StringType prognosis
Estimate of likely outcome. -
protocol
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. -
resolved
List<CodeableConcept> resolved
Diagnoses/conditions resolved since the last assessment. -
ruledOut
List<ClinicalImpression.ClinicalImpressionRuledOutComponent> ruledOut
Diagnosis considered not possible. -
status
Enumeration<ClinicalImpression.ClinicalImpressionStatus> status
Identifies the workflow status of the assessment. -
summary
StringType summary
A text summary of the investigations and the diagnosis. -
trigger
Type trigger
The request or event that necessitated this assessment. This may be a diagnosis, a Care Plan, a Request Referral, or some other resource.
-
-
Class org.hl7.fhir.dstu2.model.ClinicalImpression.ClinicalImpressionFindingComponent
class ClinicalImpressionFindingComponent extends BackboneElement implements Serializable- serialVersionUID:
- -888590978L
-
Serialized Fields
-
cause
StringType cause
Which investigations support finding or diagnosis. -
item
CodeableConcept item
Specific text of code for finding or diagnosis.
-
-
Class org.hl7.fhir.dstu2.model.ClinicalImpression.ClinicalImpressionInvestigationsComponent
class ClinicalImpressionInvestigationsComponent 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.dstu2.model.ClinicalImpression.ClinicalImpressionRuledOutComponent
class ClinicalImpressionRuledOutComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1001661243L
-
Serialized Fields
-
item
CodeableConcept item
Specific text of code for diagnosis. -
reason
StringType reason
Grounds for elimination.
-
-
Class org.hl7.fhir.dstu2.model.ClinicalImpression.ClinicalImpressionStatusEnumFactory
class ClinicalImpressionStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.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.dstu2.model.CodeType
class CodeType extends StringType implements Serializable- serialVersionUID:
- 3L
-
Class org.hl7.fhir.dstu2.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.dstu2.model.Communication
class Communication extends DomainResource implements Serializable- serialVersionUID:
- -1654449146L
-
Serialized Fields
-
category
CodeableConcept category
The type of message conveyed such as alert, notification, reminder, instruction, etc. -
encounter
Reference encounter
The encounter within which the communication was sent. -
encounterTarget
Encounter encounterTarget
The actual object that is the target of the reference (The encounter within which the communication was sent.) -
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). -
payload
List<Communication.CommunicationPayloadComponent> payload
Text, attachment(s), or resource(s) that was communicated to the recipient. -
reason
List<CodeableConcept> reason
The reason or justification for the 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).) -
requestDetail
Reference requestDetail
The communication request that was responsible for producing this communication. -
requestDetailTarget
CommunicationRequest requestDetailTarget
The actual object that is the target of the reference (The communication request that was responsible for producing this communication.) -
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 who was the focus of this communication. -
subjectTarget
Patient subjectTarget
The actual object that is the target of the reference (The patient who was the focus of this communication.)
-
-
Class org.hl7.fhir.dstu2.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.dstu2.model.Communication.CommunicationStatusEnumFactory
class CommunicationStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.CommunicationRequest
class CommunicationRequest extends DomainResource implements Serializable- serialVersionUID:
- 146906020L
-
Serialized Fields
-
category
CodeableConcept category
The type of message to be sent such as alert, notification, reminder, instruction, etc. -
encounter
Reference encounter
The encounter within which the communication request was created. -
encounterTarget
Encounter encounterTarget
The actual object that is the target of the reference (The encounter within which the communication request was created.) -
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). -
payload
List<CommunicationRequest.CommunicationRequestPayloadComponent> payload
Text, attachment(s), or resource(s) to be communicated to the recipient. -
priority
CodeableConcept priority
Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine. -
reason
List<CodeableConcept> reason
The reason or justification for the communication request. -
recipient
List<Reference> recipient
The entity (e.g. person, organization, clinical information system, or device) 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, or device) which is the intended target of the communication.) -
requestedOn
DateTimeType requestedOn
The time when the request was made. -
requester
Reference requester
The responsible person who authorizes this order, e.g. physician. This may be different than the author of the order statement, e.g. clerk, who may have entered the statement into the order entry application. -
requesterTarget
Resource requesterTarget
The actual object that is the target of the reference (The responsible person who authorizes this order, e.g. physician. This may be different than the author of the order statement, e.g. clerk, who may have entered the statement into the order entry application.) -
scheduled
Type scheduled
The time when this communication is to occur. -
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 who is the focus of this communication request. -
subjectTarget
Patient subjectTarget
The actual object that is the target of the reference (The patient who is the focus of this communication request.)
-
-
Class org.hl7.fhir.dstu2.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.dstu2.model.CommunicationRequest.CommunicationRequestStatusEnumFactory
class CommunicationRequestStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Composition
class Composition extends DomainResource implements Serializable- serialVersionUID:
- 2127852326L
-
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
CodeType 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. -
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.dstu2.model.Composition.CompositionAttestationModeEnumFactory
class CompositionAttestationModeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.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 composition was attested by the party.
-
-
Class org.hl7.fhir.dstu2.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.dstu2.model.Composition.CompositionStatusEnumFactory
class CompositionStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Composition.SectionComponent
class SectionComponent extends BackboneElement implements Serializable- serialVersionUID:
- -726390626L
-
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
CodeType 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.dstu2.model.ConceptMap
class ConceptMap extends DomainResource implements Serializable- serialVersionUID:
- 1687563642L
-
Serialized Fields
-
contact
List<ConceptMap.ConceptMapContactComponent> contact
Contacts to assist a user in finding and communicating with the publisher. -
copyright
StringType copyright
A copyright statement relating to the concept map and/or its contents. -
date
DateTimeType date
The date this version of the concept map was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the concept map changes. -
description
StringType description
A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc. -
element
List<ConceptMap.SourceElementComponent> element
Mappings for an individual concept in the source to one or more concepts in the target. -
experimental
BooleanType experimental
This ConceptMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. -
identifier
Identifier identifier
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. -
name
StringType name
A free text natural language name describing the concept map. -
publisher
StringType publisher
The name of the individual or organization that published the concept map. -
requirements
StringType requirements
Explains why this concept map is needed and why it has been constrained as it has. -
source
Type source
The source value set that specifies the concepts that are being mapped. -
status
Enumeration<Enumerations.ConformanceResourceStatus> status
The status of the concept map. -
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. -
url
UriType url
An absolute URL that is used to identify this concept map when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this concept map is (or will be) published. -
useContext
List<CodeableConcept> useContext
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of concept map instances. -
version
StringType version
The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.
-
-
Class org.hl7.fhir.dstu2.model.ConceptMap.ConceptMapContactComponent
class ConceptMapContactComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1179697803L
-
Serialized Fields
-
name
StringType name
The name of an individual to contact regarding the concept map. -
telecom
List<ContactPoint> telecom
Contact details for individual (if a name was provided) or the publisher.
-
-
Class org.hl7.fhir.dstu2.model.ConceptMap.OtherElementComponent
class OtherElementComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1488522448L
-
Serialized Fields
-
code
StringType code
Identity (code or path) or the element/item/ValueSet that the map depends on / refers to. -
codeSystem
UriType codeSystem
An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that crosses code systems). -
element
UriType element
A reference to a specific concept that holds a coded value. This can be an element in a FHIR resource, or a specific reference to a data element in a different specification (e.g. HL7 v2) or a general reference to a kind of data field, or a reference to a value set with an appropriately narrow definition.
-
-
Class org.hl7.fhir.dstu2.model.ConceptMap.SourceElementComponent
class SourceElementComponent extends BackboneElement implements Serializable- serialVersionUID:
- -458143877L
-
Serialized Fields
-
code
CodeType code
Identity (code or path) or the element/item being mapped. -
codeSystem
UriType codeSystem
An absolute URI that identifies the Code System (if the source is a value set that crosses more than one code system). -
target
List<ConceptMap.TargetElementComponent> target
A concept from the target value set that this concept maps to.
-
-
Class org.hl7.fhir.dstu2.model.ConceptMap.TargetElementComponent
class TargetElementComponent extends BackboneElement implements Serializable- serialVersionUID:
- -804990059L
-
Serialized Fields
-
code
CodeType code
Identity (code or path) or the element/item that the map refers to. -
codeSystem
UriType codeSystem
An absolute URI that identifies the code system of the target code (if the target is a value set that cross code systems). -
comments
StringType comments
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. -
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.dstu2.model.Condition
class Condition extends DomainResource implements Serializable- serialVersionUID:
- -341227215L
-
Serialized Fields
-
abatement
Type abatement
The date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" - Conditions are never really resolved, but they can abate. -
asserter
Reference asserter
Individual who is making the condition statement. -
asserterTarget
Resource asserterTarget
The actual object that is the target of the reference (Individual who is making the condition statement.) -
bodySite
List<CodeableConcept> bodySite
The anatomical location where this condition manifests itself. -
category
CodeableConcept category
A category assigned to the condition. -
clinicalStatus
CodeType clinicalStatus
The clinical status of the condition. -
code
CodeableConcept code
Identification of the condition, problem or diagnosis. -
dateRecorded
DateType dateRecorded
A date, when the Condition statement was documented. -
encounter
Reference encounter
Encounter during which the condition was first asserted. -
encounterTarget
Encounter encounterTarget
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). -
notes
StringType notes
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. -
patient
Reference patient
Indicates the patient who the condition record is associated with. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (Indicates the patient who the condition record is associated with.) -
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. -
verificationStatus
Enumeration<Condition.ConditionVerificationStatus> verificationStatus
The verification status to support the clinical status of the condition.
-
-
Class org.hl7.fhir.dstu2.model.Condition.ConditionEvidenceComponent
class ConditionEvidenceComponent extends BackboneElement implements Serializable- serialVersionUID:
- 945689926L
-
Serialized Fields
-
code
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.dstu2.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.dstu2.model.Condition.ConditionVerificationStatusEnumFactory
class ConditionVerificationStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Conformance
class Conformance extends DomainResource implements Serializable- serialVersionUID:
- 1863739648L
-
Serialized Fields
-
acceptUnknown
Enumeration<Conformance.UnknownContentCode> acceptUnknown
A code that indicates whether the application accepts unknown elements or extensions when reading resources. -
contact
List<Conformance.ConformanceContactComponent> contact
Contacts to assist a user in finding and communicating with the publisher. -
copyright
StringType copyright
A copyright statement relating to the conformance statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the system described by the conformance statement. -
date
DateTimeType date
The date (and optionally time) when the conformance statement was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the conformance statement changes. -
description
StringType description
A free text natural language description of the conformance statement and its use. Typically, this is used when the conformance statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP. -
document
List<Conformance.ConformanceDocumentComponent> document
A document definition. -
experimental
BooleanType experimental
A flag to indicate that this conformance statement is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. -
fhirVersion
IdType fhirVersion
The version of the FHIR specification on which this conformance statement is based. -
format
List<CodeType> format
A list of the formats supported by this implementation using their content types. -
implementation
Conformance.ConformanceImplementationComponent implementation
Identifies a specific implementation instance that is described by the conformance statement - i.e. a particular installation, rather than the capabilities of a software program. -
kind
Enumeration<Conformance.ConformanceStatementKind> 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<Conformance.ConformanceMessagingComponent> messaging
A description of the messaging capabilities of the solution. -
name
StringType name
A free text natural language name identifying the conformance statement. -
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}.) -
publisher
StringType publisher
The name of the individual or organization that published the conformance. -
requirements
StringType requirements
Explains why this conformance statement is needed and why it's been constrained as it has. -
rest
List<Conformance.ConformanceRestComponent> rest
A definition of the restful capabilities of the solution, if any. -
software
Conformance.ConformanceSoftwareComponent software
Software that is covered by this conformance statement. It is used when the conformance statement describes the capabilities of a particular software version, independent of an installation. -
status
Enumeration<Enumerations.ConformanceResourceStatus> status
The status of this conformance statement. -
url
UriType url
An absolute URL that is used to identify this conformance statement when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this conformance statement is (or will be) published. -
version
StringType version
The identifier that is used to identify this version of the conformance statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.
-
-
Class org.hl7.fhir.dstu2.model.Conformance.ConditionalDeleteStatusEnumFactory
class ConditionalDeleteStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Conformance.ConformanceContactComponent
class ConformanceContactComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1179697803L
-
Serialized Fields
-
name
StringType name
The name of an individual to contact regarding the conformance. -
telecom
List<ContactPoint> telecom
Contact details for individual (if a name was provided) or the publisher.
-
-
Class org.hl7.fhir.dstu2.model.Conformance.ConformanceDocumentComponent
class ConformanceDocumentComponent 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 are documents created, what action is taken with consumed documents, etc. -
mode
Enumeration<Conformance.DocumentMode> mode
Mode of this document declaration - whether application is 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.dstu2.model.Conformance.ConformanceEventModeEnumFactory
class ConformanceEventModeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Conformance.ConformanceImplementationComponent
class ConformanceImplementationComponent extends BackboneElement implements Serializable- serialVersionUID:
- -289238508L
-
Serialized Fields
-
description
StringType description
Information about the specific installation that this conformance 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.dstu2.model.Conformance.ConformanceMessagingComponent
class ConformanceMessagingComponent extends BackboneElement implements Serializable- serialVersionUID:
- -712362545L
-
Serialized Fields
-
documentation
StringType documentation
Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the conformance statement. For example, process for becoming an authorized messaging exchange partner. -
endpoint
List<Conformance.ConformanceMessagingEndpointComponent> endpoint
An endpoint (network accessible address) to which messages and/or replies are to be sent. -
event
List<Conformance.ConformanceMessagingEventComponent> 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).
-
-
Class org.hl7.fhir.dstu2.model.Conformance.ConformanceMessagingEndpointComponent
class ConformanceMessagingEndpointComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1294656428L
-
Class org.hl7.fhir.dstu2.model.Conformance.ConformanceMessagingEventComponent
class ConformanceMessagingEventComponent extends BackboneElement implements Serializable- serialVersionUID:
- -47031390L
-
Serialized Fields
-
category
Enumeration<Conformance.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<Conformance.ConformanceEventMode> mode
The mode of this event declaration - whether application is 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.dstu2.model.Conformance.ConformanceRestComponent
class ConformanceRestComponent extends BackboneElement implements Serializable- serialVersionUID:
- 931983837L
-
Serialized Fields
-
compartment
List<UriType> compartment
An absolute URI which is a reference to the definition of a compartment hosted by the system. -
documentation
StringType documentation
Information about the system's restful capabilities that apply across all applications, such as security. -
interaction
List<Conformance.SystemInteractionComponent> interaction
A specification of restful operations supported by the system. -
mode
Enumeration<Conformance.RestfulConformanceMode> mode
Identifies whether this portion of the statement is describing ability to initiate or receive restful operations. -
operation
List<Conformance.ConformanceRestOperationComponent> operation
Definition of an operation or a named query and with its parameters and their meaning and type. -
resource
List<Conformance.ConformanceRestResourceComponent> resource
A specification of the restful capabilities of the solution for a specific resource type. -
searchParam
List<Conformance.ConformanceRestResourceSearchParamComponent> 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
Conformance.ConformanceRestSecurityComponent security
Information about security implementation from an interface perspective - what a client needs to know. -
transactionMode
Enumeration<Conformance.TransactionMode> transactionMode
A code that indicates how transactions are supported.
-
-
Class org.hl7.fhir.dstu2.model.Conformance.ConformanceRestOperationComponent
class ConformanceRestOperationComponent 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 a query, which is used in the _query parameter when the query is called.
-
-
Class org.hl7.fhir.dstu2.model.Conformance.ConformanceRestResourceComponent
class ConformanceRestResourceComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1781959905L
-
Serialized Fields
-
conditionalCreate
BooleanType conditionalCreate
A flag that indicates that the server supports conditional create. -
conditionalDelete
Enumeration<Conformance.ConditionalDeleteStatus> conditionalDelete
A code that indicates how the server supports conditional delete. -
conditionalUpdate
BooleanType conditionalUpdate
A flag that indicates that the server supports conditional update. -
interaction
List<Conformance.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. -
searchInclude
List<StringType> searchInclude
A list of _include values supported by the server. -
searchParam
List<Conformance.ConformanceRestResourceSearchParamComponent> 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<Conformance.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.dstu2.model.Conformance.ConformanceRestResourceSearchParamComponent
class ConformanceRestResourceSearchParamComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1020405086L
-
Serialized Fields
-
chain
List<StringType> chain
Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference, and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from Conformance.rest.resource.searchParam.name on the target resource type. -
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. -
modifier
List<Enumeration<Conformance.SearchModifierCode>> modifier
A modifier supported for the search parameter. -
name
StringType name
The name of the search parameter used in the interface. -
target
List<CodeType> target
Types of resource (if a resource is referenced). -
type
Enumeration<Enumerations.SearchParamType> type
The type of value a search parameter refers to, and how the content is interpreted.
-
-
Class org.hl7.fhir.dstu2.model.Conformance.ConformanceRestSecurityCertificateComponent
class ConformanceRestSecurityCertificateComponent extends BackboneElement implements Serializable- serialVersionUID:
- 2092655854L
-
Serialized Fields
-
blob
Base64BinaryType blob
Actual certificate. -
type
CodeType type
Mime type for certificate.
-
-
Class org.hl7.fhir.dstu2.model.Conformance.ConformanceRestSecurityComponent
class ConformanceRestSecurityComponent extends BackboneElement implements Serializable- serialVersionUID:
- 391663952L
-
Serialized Fields
-
certificate
List<Conformance.ConformanceRestSecurityCertificateComponent> 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 are supported/required by the system.
-
-
Class org.hl7.fhir.dstu2.model.Conformance.ConformanceSoftwareComponent
class ConformanceSoftwareComponent 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 released. -
version
StringType version
The version identifier for the software covered by this statement.
-
-
Class org.hl7.fhir.dstu2.model.Conformance.ConformanceStatementKindEnumFactory
class ConformanceStatementKindEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Conformance.DocumentModeEnumFactory
class DocumentModeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Conformance.MessageSignificanceCategoryEnumFactory
class MessageSignificanceCategoryEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Conformance.ResourceInteractionComponent
class ResourceInteractionComponent extends BackboneElement implements Serializable- serialVersionUID:
- -437507806L
-
Serialized Fields
-
code
Enumeration<Conformance.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.dstu2.model.Conformance.ResourceVersionPolicyEnumFactory
class ResourceVersionPolicyEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Conformance.RestfulConformanceModeEnumFactory
class RestfulConformanceModeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Conformance.SearchModifierCodeEnumFactory
class SearchModifierCodeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Conformance.SystemInteractionComponent
class SystemInteractionComponent extends BackboneElement implements Serializable- serialVersionUID:
- 510675287L
-
Serialized Fields
-
code
Enumeration<Conformance.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.dstu2.model.Conformance.SystemRestfulInteractionEnumFactory
class SystemRestfulInteractionEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Conformance.TransactionModeEnumFactory
class TransactionModeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Conformance.TypeRestfulInteractionEnumFactory
class TypeRestfulInteractionEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Conformance.UnknownContentCodeEnumFactory
class UnknownContentCodeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.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.dstu2.model.ContactPoint.ContactPointSystemEnumFactory
class ContactPointSystemEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.ContactPoint.ContactPointUseEnumFactory
class ContactPointUseEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Contract
class Contract extends DomainResource implements Serializable- serialVersionUID:
- -1785608373L
-
Serialized Fields
-
action
List<CodeableConcept> action
Action stipulated by this Contract. -
actionReason
List<CodeableConcept> actionReason
Reason for action stipulated by this Contract. -
actor
List<Contract.ActorComponent> actor
List of Contract actors. -
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. -
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. -
signer
List<Contract.SignatoryComponent> signer
Party signing this Contract. -
subject
List<Reference> subject
Who and/or what this Contract is about: typically a Patient, Organization, or valued items such as goods and services. -
subjectTarget
List<Resource> subjectTarget
The actual objects that are the target of the reference (Who and/or what this Contract is about: typically a Patient, Organization, or valued items such as goods and services.) -
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. -
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.dstu2.model.Contract.ActorComponent
class ActorComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1371245689L
-
Serialized Fields
-
entity
Reference entity
Who or what actors are assigned roles in this Contract. -
entityTarget
Resource entityTarget
The actual object that is the target of the reference (Who or what actors are assigned roles in this Contract.) -
role
List<CodeableConcept> role
Role type of actors assigned roles in this Contract.
-
-
Class org.hl7.fhir.dstu2.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.dstu2.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.dstu2.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.dstu2.model.Contract.SignatoryComponent
class SignatoryComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1870392043L
-
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
StringType 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.dstu2.model.Contract.TermActorComponent
class TermActorComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1371245689L
-
Serialized Fields
-
entity
Reference entity
The actor assigned a role in this Contract Provision. -
entityTarget
Resource entityTarget
The actual object that is the target of the reference (The actor assigned a role in this Contract Provision.) -
role
List<CodeableConcept> role
Role played by the actor assigned this role in this Contract Provision.
-
-
Class org.hl7.fhir.dstu2.model.Contract.TermComponent
class TermComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1137577465L
-
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. -
actor
List<Contract.TermActorComponent> actor
List of actors participating in this Contract Provision. -
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. -
subject
Reference subject
Who or what this Contract Provision is about. -
subjectTarget
Resource subjectTarget
The actual object that is the target of the reference (Who or what this Contract Provision is about.) -
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. -
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.dstu2.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.dstu2.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.dstu2.model.Count
class Count extends Quantity implements Serializable- serialVersionUID:
- 1069574054L
-
Class org.hl7.fhir.dstu2.model.Coverage
class Coverage extends DomainResource implements Serializable- serialVersionUID:
- -1312031251L
-
Serialized Fields
-
bin
Identifier bin
Business Identification Number (BIN number) used to identify the routing of eclaims if the insurer themselves don't have a BIN number for all of their business. -
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
PositiveIntType dependent
A unique identifier for a dependent under the coverage. -
group
StringType group
Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID. -
identifier
List<Identifier> identifier
The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Subscriber Id, Certificate number or Personal Health Number or Case ID. -
issuer
Reference issuer
The program or plan underwriter or payor. -
issuerTarget
Organization issuerTarget
The actual object that is the target of the reference (The program or plan underwriter or payor.) -
network
Identifier network
The identifier for a community of providers. -
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. -
plan
StringType plan
Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID. -
sequence
PositiveIntType sequence
An optional counter for a particular instance of the identified coverage which increments upon each renewal. -
subPlan
StringType subPlan
Identifies a sub-style or sub-collective of coverage issues by the underwriter, for example may be used to identify a specific employer group within a class of employers. May be referred to as a Section or Division ID. -
subscriber
Reference subscriber
The party who 'owns' the insurance contractual relationship to the policy or to whom the benefit of the policy is due. -
subscriberId
Identifier subscriberId
The id issued to the subscriber. -
subscriberTarget
Patient subscriberTarget
The actual object that is the target of the reference (The party who 'owns' the insurance contractual relationship to the policy or to whom the benefit of the policy is due.) -
type
Coding type
The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health.
-
-
Class org.hl7.fhir.dstu2.model.DataElement
class DataElement extends DomainResource implements Serializable- serialVersionUID:
- 2017352331L
-
Serialized Fields
-
contact
List<DataElement.DataElementContactComponent> contact
Contacts to assist a user in finding and communicating with the publisher. -
copyright
StringType copyright
A copyright statement relating to the definition of the data element. Copyright statements are generally legal restrictions on the use and publishing of the details of the definition of the data element. -
date
DateTimeType date
The date this version of the data element was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the data element changes. -
element
List<ElementDefinition> element
Defines the structure, type, allowed values and other constraining characteristics of the data element. -
experimental
BooleanType experimental
A flag to indicate that this search data element definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. -
identifier
List<Identifier> identifier
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. -
name
StringType name
The term used by humans to refer to the data element. Should ideally be unique within the context in which the data element is expected to be used. -
publisher
StringType publisher
The name of the individual or organization that published the data element. -
status
Enumeration<Enumerations.ConformanceResourceStatus> status
The status of the data element. -
stringency
Enumeration<DataElement.DataElementStringency> stringency
Identifies how precise the data element is in its definition. -
url
UriType url
An absolute URL that is used to identify this data element when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this data element is (or will be) published. -
useContext
List<CodeableConcept> useContext
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of data element definitions. -
version
StringType version
The identifier that is used to identify this version of the data element when it is referenced in a StructureDefinition, Questionnaire or instance. This is an arbitrary value managed by the definition author manually.
-
-
Class org.hl7.fhir.dstu2.model.DataElement.DataElementContactComponent
class DataElementContactComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1179697803L
-
Serialized Fields
-
name
StringType name
The name of an individual to contact regarding the data element. -
telecom
List<ContactPoint> telecom
Contact details for individual (if a name was provided) or the publisher.
-
-
Class org.hl7.fhir.dstu2.model.DataElement.DataElementMappingComponent
class DataElementMappingComponent extends BackboneElement implements Serializable- serialVersionUID:
- 299630820L
-
Serialized Fields
-
comments
StringType comments
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.dstu2.model.DataElement.DataElementStringencyEnumFactory
class DataElementStringencyEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.DateTimeType
class DateTimeType extends BaseDateTimeType implements Serializable- serialVersionUID:
- 3L
-
Class org.hl7.fhir.dstu2.model.DateType
class DateType extends BaseDateTimeType implements Serializable- serialVersionUID:
- 3L
-
Class org.hl7.fhir.dstu2.model.DecimalType
- serialVersionUID:
- 3L
-
Class org.hl7.fhir.dstu2.model.DetectedIssue
class DetectedIssue extends DomainResource implements Serializable- serialVersionUID:
- -403732234L
-
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.
-
-
Class org.hl7.fhir.dstu2.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.dstu2.model.DetectedIssue.DetectedIssueSeverityEnumFactory
class DetectedIssueSeverityEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Device
class Device extends DomainResource implements Serializable- serialVersionUID:
- 366690094L
-
Serialized Fields
-
contact
List<ContactPoint> contact
Contact details for an organization or a particular human that is responsible for the device. -
expiry
DateTimeType expiry
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 organizations like manufacturers or owners. If the identifier identifies the type of device, Device.type should be used. -
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 resource is affixed to a person. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (Patient information, if the resource is affixed to a person.) -
status
Enumeration<Device.DeviceStatus> status
Status of the Device availability. -
type
CodeableConcept type
Code or identifier to identify a kind of device. -
udi
StringType udi
United States Food and Drug Administration mandated Unique Device Identifier (UDI). Use the human readable information (the content that the user sees, which is sometimes different to the exact syntax represented in the barcode) - see http://www.fda.gov/MedicalDevices/DeviceRegulationandGuidance/UniqueDeviceIdentification/default.htm. -
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.dstu2.model.Device.DeviceStatusEnumFactory
class DeviceStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.DeviceComponent
class DeviceComponent extends DomainResource implements Serializable- serialVersionUID:
- -1742890034L
-
Serialized Fields
-
identifier
Identifier identifier
Describes the local assigned unique identification by the software. For example: handle ID. -
languageCode
CodeableConcept languageCode
Describes 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
Describes the timestamp for the most recent system change which includes device configuration or setting change. -
measurementPrinciple
Enumeration<DeviceComponent.MeasmntPrinciple> measurementPrinciple
Describes the physical principle of the measurement. For example: thermal, chemical, acoustical, etc. -
operationalStatus
List<CodeableConcept> operationalStatus
Indicates current operational status of the device. For example: On, Off, Standby, etc. -
parameterGroup
CodeableConcept parameterGroup
Describes the parameter group supported by the current device component that is based on some nomenclature, e.g. cardiovascular. -
parent
Reference parent
Describes 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 (Describes the link to the parent resource. For example: Channel is linked to its VMD parent.) -
productionSpecification
List<DeviceComponent.DeviceComponentProductionSpecificationComponent> productionSpecification
Describes the production specification such as component revision, serial number, etc. -
source
Reference source
Describes 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 (Describes the link to the source Device that contains administrative device information such as manufacture, serial number, etc.) -
type
CodeableConcept type
Describes the specific component type as defined in the object-oriented or metric nomenclature partition.
-
-
Class org.hl7.fhir.dstu2.model.DeviceComponent.DeviceComponentProductionSpecificationComponent
class DeviceComponentProductionSpecificationComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1476597516L
-
Serialized Fields
-
componentId
Identifier componentId
Describes 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 manufacture can make use of. -
productionSpec
StringType productionSpec
Describes the printable string defining the component. -
specType
CodeableConcept specType
Describes the specification type, such as, serial number, part number, hardware revision, software revision, etc.
-
-
Class org.hl7.fhir.dstu2.model.DeviceComponent.MeasmntPrincipleEnumFactory
class MeasmntPrincipleEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.DeviceMetric
class DeviceMetric extends DomainResource implements Serializable- serialVersionUID:
- 1786401018L
-
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 manufacture, 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 manufacture, 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.dstu2.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.dstu2.model.DeviceMetric.DeviceMetricCalibrationStateEnumFactory
class DeviceMetricCalibrationStateEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.DeviceMetric.DeviceMetricCalibrationTypeEnumFactory
class DeviceMetricCalibrationTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.DeviceMetric.DeviceMetricCategoryEnumFactory
class DeviceMetricCategoryEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.DeviceMetric.DeviceMetricColorEnumFactory
class DeviceMetricColorEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.DeviceMetric.DeviceMetricOperationalStatusEnumFactory
class DeviceMetricOperationalStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.DeviceUseRequest
class DeviceUseRequest extends DomainResource implements Serializable- serialVersionUID:
- 1208477058L
-
Serialized Fields
-
bodySite
Type bodySite
Indicates the site on the subject's body where the device should be used ( i.e. the target site). -
device
Reference device
The details of the device to be used. -
deviceTarget
Device deviceTarget
The actual object that is the target of the reference (The details of the device to be used.) -
encounter
Reference encounter
An encounter that provides additional context in which this request is made. -
encounterTarget
Encounter encounterTarget
The actual object that is the target of the reference (An encounter that provides additional context in which this request is made.) -
identifier
List<Identifier> identifier
Identifiers assigned to this order by the orderer or by the receiver. -
indication
List<CodeableConcept> indication
Reason or justification for the use of this device. -
notes
List<StringType> notes
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. -
orderedOn
DateTimeType orderedOn
The time when the request was made. -
priority
Enumeration<DeviceUseRequest.DeviceUseRequestPriority> priority
Characterizes how quickly the use of device must be initiated. Includes concepts such as stat, urgent, routine. -
prnReason
List<CodeableConcept> prnReason
The proposed act must be performed if the indicated conditions occur, e.g.., shortness of breath, SpO2 less than x%. -
recordedOn
DateTimeType recordedOn
The time at which the request was made/recorded. -
status
Enumeration<DeviceUseRequest.DeviceUseRequestStatus> status
The status of the request. -
subject
Reference subject
The patient who will use the device. -
subjectTarget
Patient subjectTarget
The actual object that is the target of the reference (The patient who will use the device.) -
timing
Type timing
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".
-
-
Class org.hl7.fhir.dstu2.model.DeviceUseRequest.DeviceUseRequestPriorityEnumFactory
class DeviceUseRequestPriorityEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.DeviceUseRequest.DeviceUseRequestStatusEnumFactory
class DeviceUseRequestStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.DeviceUseStatement
class DeviceUseStatement extends DomainResource implements Serializable- serialVersionUID:
- -1668571635L
-
Serialized Fields
-
bodySite
Type 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. -
notes
List<StringType> notes
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. -
subject
Reference subject
The patient who used the device. -
subjectTarget
Patient 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.dstu2.model.DiagnosticOrder
class DiagnosticOrder extends DomainResource implements Serializable- serialVersionUID:
- 700891227L
-
Serialized Fields
-
encounter
Reference encounter
An encounter that provides additional information about the healthcare context in which this request is made. -
encounterTarget
Encounter encounterTarget
The actual object that is the target of the reference (An encounter that provides additional information about the healthcare context in which this request is made.) -
event
List<DiagnosticOrder.DiagnosticOrderEventComponent> event
A summary of the events of interest that have occurred as the request is processed; e.g. when the order was made, various processing steps (specimens received), when it was completed. -
identifier
List<Identifier> identifier
Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. -
item
List<DiagnosticOrder.DiagnosticOrderItemComponent> item
The specific diagnostic investigations that are requested as part of this request. Sometimes, there can only be one item per request, but in most contexts, more than one investigation can be requested. -
note
List<Annotation> note
Any other notes associated with this patient, specimen or order (e.g. "patient hates needles"). -
orderer
Reference orderer
The practitioner that holds legal responsibility for ordering the investigation. -
ordererTarget
Practitioner ordererTarget
The actual object that is the target of the reference (The practitioner that holds legal responsibility for ordering the investigation.) -
priority
Enumeration<DiagnosticOrder.DiagnosticOrderPriority> priority
The clinical priority associated with this order. -
reason
List<CodeableConcept> reason
An explanation or justification for why this diagnostic investigation is being requested. This is often for billing purposes. May relate to the resources referred to in supportingInformation. -
specimen
List<Reference> specimen
One or more specimens that the diagnostic investigation is about. -
specimenTarget
List<Specimen> specimenTarget
The actual objects that are the target of the reference (One or more specimens that the diagnostic investigation is about.) -
status
Enumeration<DiagnosticOrder.DiagnosticOrderStatus> status
The status of the order. -
subject
Reference subject
Who or what the investigation is to be performed on. This is usually a human patient, but diagnostic tests can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans). -
subjectTarget
Resource subjectTarget
The actual object that is the target of the reference (Who or what the investigation is to be performed on. This is usually a human patient, but diagnostic tests can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).) -
supportingInformation
List<Reference> supportingInformation
Additional clinical information about the patient or specimen that may influence test interpretations. This includes observations explicitly requested by the producer(filler) to provide context or supporting information needed to complete the order. -
supportingInformationTarget
List<Resource> supportingInformationTarget
The actual objects that are the target of the reference (Additional clinical information about the patient or specimen that may influence test interpretations. This includes observations explicitly requested by the producer(filler) to provide context or supporting information needed to complete the order.)
-
-
Class org.hl7.fhir.dstu2.model.DiagnosticOrder.DiagnosticOrderEventComponent
class DiagnosticOrderEventComponent extends BackboneElement implements Serializable- serialVersionUID:
- -370793723L
-
Serialized Fields
-
actor
Reference actor
The person responsible for performing or recording the action. -
actorTarget
Resource actorTarget
The actual object that is the target of the reference (The person responsible for performing or recording the action.) -
dateTime
DateTimeType dateTime
The date/time at which the event occurred. -
description
CodeableConcept description
Additional information about the event that occurred - e.g. if the status remained unchanged. -
status
Enumeration<DiagnosticOrder.DiagnosticOrderStatus> status
The status for the event.
-
-
Class org.hl7.fhir.dstu2.model.DiagnosticOrder.DiagnosticOrderItemComponent
class DiagnosticOrderItemComponent extends BackboneElement implements Serializable- serialVersionUID:
- 381238192L
-
Serialized Fields
-
bodySite
CodeableConcept bodySite
Anatomical location where the request test should be performed. This is the target site. -
code
CodeableConcept code
A code that identifies a particular diagnostic investigation, or panel of investigations, that have been requested. -
event
List<DiagnosticOrder.DiagnosticOrderEventComponent> event
A summary of the events of interest that have occurred as this item of the request is processed. -
specimen
List<Reference> specimen
If the item is related to a specific specimen. -
specimenTarget
List<Specimen> specimenTarget
The actual objects that are the target of the reference (If the item is related to a specific specimen.) -
status
Enumeration<DiagnosticOrder.DiagnosticOrderStatus> status
The status of this individual item within the order.
-
-
Class org.hl7.fhir.dstu2.model.DiagnosticOrder.DiagnosticOrderPriorityEnumFactory
class DiagnosticOrderPriorityEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.DiagnosticOrder.DiagnosticOrderStatusEnumFactory
class DiagnosticOrderStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.DiagnosticReport
class DiagnosticReport extends DomainResource implements Serializable- serialVersionUID:
- 920334551L
-
Serialized Fields
-
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 narrative interpretation of the diagnostic report. -
effective
Type effective
The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself. -
encounter
Reference encounter
The link to the health care event (encounter) when the order was made. -
encounterTarget
Encounter encounterTarget
The actual object that is the target of the reference (The link to the health care event (encounter) when the order was made.) -
identifier
List<Identifier> identifier
The local ID assigned to the report by the order filler, usually by the Information System of the diagnostic service provider. -
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
Reference performer
The diagnostic service that is responsible for issuing the report. -
performerTarget
Resource performerTarget
The actual object that is the target of the reference (The diagnostic service that is responsible for issuing the report.) -
presentedForm
List<Attachment> presentedForm
Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. -
request
List<Reference> request
Details concerning a test or procedure requested. -
requestTarget
List<Resource> requestTarget
The actual objects that are the target of the reference (Details concerning a test or procedure requested.) -
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.dstu2.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.dstu2.model.DiagnosticReport.DiagnosticReportStatusEnumFactory
class DiagnosticReportStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Distance
class Distance extends Quantity implements Serializable- serialVersionUID:
- 1069574054L
-
Class org.hl7.fhir.dstu2.model.DocumentManifest
class DocumentManifest extends DomainResource implements Serializable- serialVersionUID:
- -2056683927L
-
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.dstu2.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.dstu2.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, DiagnosticOrder, Procedure, EligibilityRequest, etc. -
refTarget
Resource refTarget
The actual object that is the target of the reference (Related Resource to this DocumentManifest. For example, Order, DiagnosticOrder, Procedure, EligibilityRequest, etc.)
-
-
Class org.hl7.fhir.dstu2.model.DocumentReference
class DocumentReference extends DomainResource implements Serializable- serialVersionUID:
- -1009325322L
-
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
CodeableConcept 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.dstu2.model.DocumentReference.DocumentReferenceContentComponent
class DocumentReferenceContentComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1412643085L
-
Serialized Fields
-
attachment
Attachment attachment
The document or url of the document along with critical metadata to prove content has integrity. -
format
List<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.dstu2.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.dstu2.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.dstu2.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.dstu2.model.DocumentReference.DocumentRelationshipTypeEnumFactory
class DocumentRelationshipTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.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.dstu2.model.Duration
class Duration extends Quantity implements Serializable- serialVersionUID:
- 1069574054L
-
Class org.hl7.fhir.dstu2.model.Element
class Element extends Base implements Serializable- serialVersionUID:
- -158027598L
-
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
IdType id
unique id for the element within a resource (for internal references).
-
-
Class org.hl7.fhir.dstu2.model.ElementDefinition
class ElementDefinition extends Type implements Serializable- serialVersionUID:
- -447087484L
-
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 unncessary for tools to trace the deviation of the element through the derived and related profiles. This information is only provided where the element definition represents a constraint on another element definition, and must be present if there is a base element definition. -
binding
ElementDefinition.ElementDefinitionBindingComponent binding
Binds to a value set if this element is coded (code, Coding, CodeableConcept). -
code
List<Coding> code
A code that provides the meaning for the element according to a particular terminology. -
comments
MarkdownType comments
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. -
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
Type example
A sample value for this element demonstrating the type of information that would typically be captured. -
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
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
IntegerType 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. -
name
StringType name
The name of this element definition (to refer to it from other element definitions using ElementDefinition.nameReference). This is a unique name referring to a specific set of constraints applied to this element. One use of this is to provide a name to different slices of the same element. -
nameReference
StringType nameReference
Identifies the name of a slice defined elsewhere in the profile whose constraints should be applied to the current element. -
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). -
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.dstu2.model.ElementDefinition.AggregationModeEnumFactory
class AggregationModeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.ElementDefinition.ConstraintSeverityEnumFactory
class ConstraintSeverityEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.ElementDefinition.ElementDefinitionBaseComponent
class ElementDefinitionBaseComponent extends Element implements Serializable- serialVersionUID:
- 232204455L
-
Serialized Fields
-
max
StringType max
Maximum cardinality of the base element identified by the path. -
min
IntegerType 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.dstu2.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.
-
-
Class org.hl7.fhir.dstu2.model.ElementDefinition.ElementDefinitionConstraintComponent
class ElementDefinitionConstraintComponent extends Element implements Serializable- serialVersionUID:
- 854521265L
-
Serialized Fields
-
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. -
xpath
StringType xpath
An XPath expression of constraint that can be executed to see if this constraint is met.
-
-
Class org.hl7.fhir.dstu2.model.ElementDefinition.ElementDefinitionMappingComponent
class ElementDefinitionMappingComponent extends Element implements Serializable- serialVersionUID:
- -669205371L
-
Serialized Fields
-
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.dstu2.model.ElementDefinition.ElementDefinitionSlicingComponent
class ElementDefinitionSlicingComponent extends Element implements Serializable- serialVersionUID:
- 233544215L
-
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<StringType> 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.dstu2.model.ElementDefinition.PropertyRepresentationEnumFactory
class PropertyRepresentationEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.ElementDefinition.SlicingRulesEnumFactory
class SlicingRulesEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.ElementDefinition.TypeRefComponent
class TypeRefComponent extends Element implements Serializable- serialVersionUID:
- -988693373L
-
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
CodeType code
Name of Data type or Resource that is a(or the) type used for this element. -
profile
List<UriType> profile
Identifies a profile structure or implementation Guide that SHALL hold for resources or datatypes referenced as the type of this element. Can be a local reference - to another structure in this profile, or a reference to a structure in another profile. When more than one profile is specified, the content must conform to all of them. When an implementation guide is specified, the resource SHALL conform to at least one profile defined in the implementation guide.
-
-
Class org.hl7.fhir.dstu2.model.EligibilityRequest
class EligibilityRequest extends DomainResource implements Serializable- serialVersionUID:
- 1836339504L
-
Serialized Fields
-
created
DateTimeType created
The date when this resource was created. -
identifier
List<Identifier> identifier
The Response business identifier. -
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.) -
originalRuleset
Coding originalRuleset
The style (standard) and version of the original material which was converted into this resource. -
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.) -
ruleset
Coding ruleset
The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources. -
target
Reference target
The Insurer who is target of the request. -
targetTarget
Organization targetTarget
The actual object that is the target of the reference (The Insurer who is target of the request.)
-
-
Class org.hl7.fhir.dstu2.model.EligibilityResponse
class EligibilityResponse extends DomainResource implements Serializable- serialVersionUID:
- -299931023L
-
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.) -
originalRuleset
Coding originalRuleset
The style (standard) and version of the original material which was converted into this resource. -
outcome
Enumeration<Enumerations.RemittanceOutcome> 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.) -
ruleset
Coding ruleset
The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.
-
-
Class org.hl7.fhir.dstu2.model.Encounter
class Encounter extends DomainResource implements Serializable- serialVersionUID:
- 929562300L
-
Serialized Fields
-
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_
Enumeration<Encounter.EncounterClass> class_
inpatient | outpatient | ambulatory | emergency +. -
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).) -
indication
List<Reference> indication
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. -
indicationTarget
List<Resource> indicationTarget
The actual objects that are 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.) -
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).) -
patient
Reference patient
The patient present at the encounter. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (The patient present at the encounter.) -
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.EncounterState> status
planned | arrived | in-progress | onleave | finished | cancelled. -
statusHistory
List<Encounter.EncounterStatusHistoryComponent> 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. -
type
List<CodeableConcept> type
Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
-
-
Class org.hl7.fhir.dstu2.model.Encounter.EncounterClassEnumFactory
class EncounterClassEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Encounter.EncounterHospitalizationComponent
class EncounterHospitalizationComponent extends BackboneElement implements Serializable- serialVersionUID:
- 164618034L
-
Serialized Fields
-
admitSource
CodeableConcept admitSource
From where patient was admitted (physician referral, transfer). -
admittingDiagnosis
List<Reference> admittingDiagnosis
The admitting diagnosis field is used to record the diagnosis codes as reported by admitting practitioner. This could be different or in addition to the conditions reported as reason-condition(s) for the encounter. -
admittingDiagnosisTarget
List<Condition> admittingDiagnosisTarget
The actual objects that are the target of the reference (The admitting diagnosis field is used to record the diagnosis codes as reported by admitting practitioner. This could be different or in addition to the conditions reported as reason-condition(s) for the encounter.) -
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. -
dischargeDiagnosis
List<Reference> dischargeDiagnosis
The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete. -
dischargeDiagnosisTarget
List<Condition> dischargeDiagnosisTarget
The actual objects that are the target of the reference (The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete.) -
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
Wheelchair, translator, stretcher, etc. -
specialCourtesy
List<CodeableConcept> specialCourtesy
Special courtesies (VIP, board member).
-
-
Class org.hl7.fhir.dstu2.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.dstu2.model.Encounter.EncounterLocationStatusEnumFactory
class EncounterLocationStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.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 was present during the encounter. These can overlap or be sub-sets of the overall encounters period. -
type
List<CodeableConcept> type
Role of participant in encounter.
-
-
Class org.hl7.fhir.dstu2.model.Encounter.EncounterStateEnumFactory
class EncounterStateEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Encounter.EncounterStatusHistoryComponent
class EncounterStatusHistoryComponent extends BackboneElement implements Serializable- serialVersionUID:
- 919229161L
-
Serialized Fields
-
period
Period period
The time that the episode was in the specified status. -
status
Enumeration<Encounter.EncounterState> status
planned | arrived | in-progress | onleave | finished | cancelled.
-
-
Class org.hl7.fhir.dstu2.model.EnrollmentRequest
class EnrollmentRequest extends DomainResource implements Serializable- serialVersionUID:
- -1656505325L
-
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. -
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.) -
originalRuleset
Coding originalRuleset
The style (standard) and version of the original material which was converted into this resource. -
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.) -
relationship
Coding relationship
The relationship of the patient to the subscriber. -
ruleset
Coding ruleset
The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources. -
subject
Reference subject
Patient Resource. -
subjectTarget
Patient subjectTarget
The actual object that is the target of the reference (Patient Resource.) -
target
Reference target
The Insurer who is target of the request. -
targetTarget
Organization targetTarget
The actual object that is the target of the reference (The Insurer who is target of the request.)
-
-
Class org.hl7.fhir.dstu2.model.EnrollmentResponse
class EnrollmentResponse extends DomainResource implements Serializable- serialVersionUID:
- -1740067108L
-
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.) -
originalRuleset
Coding originalRuleset
The style (standard) and version of the original material which was converted into this resource. -
outcome
Enumeration<Enumerations.RemittanceOutcome> 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
EnrollmentRequest requestTarget
The actual object that is the target of the reference (Original request resource reference.) -
ruleset
Coding ruleset
The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.
-
-
Class org.hl7.fhir.dstu2.model.Enumeration
- serialVersionUID:
- 1L
-
Serialized Fields
-
myEnumFactory
EnumFactory<T extends Enum<?>> myEnumFactory
-
-
Class org.hl7.fhir.dstu2.model.Enumerations.AdministrativeGenderEnumFactory
class AdministrativeGenderEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Enumerations.AgeUnitsEnumFactory
class AgeUnitsEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Enumerations.BindingStrengthEnumFactory
class BindingStrengthEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Enumerations.ConceptMapEquivalenceEnumFactory
class ConceptMapEquivalenceEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Enumerations.ConformanceResourceStatusEnumFactory
class ConformanceResourceStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Enumerations.DataAbsentReasonEnumFactory
class DataAbsentReasonEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Enumerations.DataTypeEnumFactory
class DataTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Enumerations.DocumentReferenceStatusEnumFactory
class DocumentReferenceStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Enumerations.FHIRDefinedTypeEnumFactory
class FHIRDefinedTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Enumerations.MessageEventEnumFactory
class MessageEventEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Enumerations.NoteTypeEnumFactory
class NoteTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Enumerations.RemittanceOutcomeEnumFactory
class RemittanceOutcomeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Enumerations.ResourceTypeEnumFactory
class ResourceTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Enumerations.SearchParamTypeEnumFactory
class SearchParamTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Enumerations.SpecialValuesEnumFactory
class SpecialValuesEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.EpisodeOfCare
class EpisodeOfCare extends DomainResource implements Serializable- serialVersionUID:
- 1652653406L
-
Serialized Fields
-
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.) -
careTeam
List<EpisodeOfCare.EpisodeOfCareCareTeamComponent> careTeam
The list of practitioners that may be facilitating this episode of care for specific purposes. -
condition
List<Reference> condition
A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for. -
conditionTarget
List<Condition> conditionTarget
The actual objects that are the target of the reference (A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for.) -
identifier
List<Identifier> identifier
Identifier(s) by which this EpisodeOfCare is known. -
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 that this EpisodeOfCare applies to. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (The patient that this EpisodeOfCare applies to.) -
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). -
type
List<CodeableConcept> type
A classification of the type of encounter; e.g. specialist referral, disease management, type of funded care.
-
-
Class org.hl7.fhir.dstu2.model.EpisodeOfCare.EpisodeOfCareCareTeamComponent
class EpisodeOfCareCareTeamComponent extends BackboneElement implements Serializable- serialVersionUID:
- -437303089L
-
Serialized Fields
-
member
Reference member
The practitioner (or Organization) within the team. -
memberTarget
Resource memberTarget
The actual object that is the target of the reference (The practitioner (or Organization) within the team.) -
period
Period period
The period of time this practitioner is performing some role within the episode of care. -
role
List<CodeableConcept> role
The role this team member is taking within this episode of care.
-
-
Class org.hl7.fhir.dstu2.model.EpisodeOfCare.EpisodeOfCareStatusEnumFactory
class EpisodeOfCareStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.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.dstu2.model.ExplanationOfBenefit
class ExplanationOfBenefit extends DomainResource implements Serializable- serialVersionUID:
- 205412587L
-
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.) -
originalRuleset
Coding originalRuleset
The style (standard) and version of the original material which was converted into this resource. -
outcome
Enumeration<Enumerations.RemittanceOutcome> 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
Claim requestTarget
The actual object that is the target of the reference (Original request resource reference.) -
ruleset
Coding ruleset
The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.
-
-
Class org.hl7.fhir.dstu2.model.Extension
class Extension extends BaseExtension implements Serializable- serialVersionUID:
- 1029480965L
-
Class org.hl7.fhir.dstu2.model.FamilyMemberHistory
class FamilyMemberHistory extends DomainResource implements Serializable- serialVersionUID:
- -1799103041L
-
Serialized Fields
-
age
Type age
The actual or approximate 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. -
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". -
note
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.) -
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 a state of a Family Member History record.
-
-
Class org.hl7.fhir.dstu2.model.FamilyMemberHistory.FamilyHistoryStatusEnumFactory
class FamilyHistoryStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.FamilyMemberHistory.FamilyMemberHistoryConditionComponent
class FamilyMemberHistoryConditionComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1221569121L
-
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
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.dstu2.model.Flag
class Flag extends DomainResource implements Serializable- serialVersionUID:
- 701147751L
-
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 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 this is about record this flag is associated with.)
-
-
Class org.hl7.fhir.dstu2.model.Flag.FlagStatusEnumFactory
class FlagStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Goal
class Goal extends DomainResource implements Serializable- serialVersionUID:
- 2029459056L
-
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.) -
author
Reference author
Indicates whose goal this is - patient goal, practitioner goal, etc. -
authorTarget
Resource authorTarget
The actual object that is the target of the reference (Indicates whose goal this is - patient goal, practitioner goal, etc.) -
category
List<CodeableConcept> category
Indicates a category the goal falls within. -
description
StringType description
Human-readable description of a specific desired objective of care. -
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. -
outcome
List<Goal.GoalOutcomeComponent> outcome
Identifies the change (or lack of change) at the point where the goal was deepmed to be cancelled or achieved. -
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
CodeableConcept 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
Type target
Indicates either the date or the duration after start by which the goal should be met.
-
-
Class org.hl7.fhir.dstu2.model.Goal.GoalOutcomeComponent
class GoalOutcomeComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1994317639L
-
Serialized Fields
-
result
Type result
Details of what's changed (or not changed).
-
-
Class org.hl7.fhir.dstu2.model.Goal.GoalStatusEnumFactory
class GoalStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Group
class Group extends DomainResource implements Serializable- serialVersionUID:
- 1401345819L
-
Serialized Fields
-
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.dstu2.model.Group.GroupCharacteristicComponent
class GroupCharacteristicComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1000688967L
-
Serialized Fields
-
code
CodeableConcept code
A code that identifies the kind of trait being asserted. -
exclude
BooleanType exclude
If true, indicates the characteristic is one that is NOT held by members of the group. -
period
Period period
The period over which the characteristic is tested; e.g. the patient had an operation during the month of June. -
value
Type value
The value of the trait that holds (or does not hold - see 'exclude') for members of the group.
-
-
Class org.hl7.fhir.dstu2.model.Group.GroupMemberComponent
class GroupMemberComponent extends BackboneElement implements Serializable- serialVersionUID:
- -333869055L
-
Serialized Fields
-
entity
Reference entity
A reference to the entity that is a member of the group. Must be consistent with Group.type. -
entityTarget
Resource entityTarget
The actual object that is the target of the reference (A reference to the entity that is a member of the group. Must be consistent with Group.type.) -
inactive
BooleanType inactive
A flag to indicate that the member is no longer in the group, but previously may have been a member. -
period
Period period
The period that the member was in the group, if known.
-
-
Class org.hl7.fhir.dstu2.model.Group.GroupTypeEnumFactory
class GroupTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.HealthcareService
class HealthcareService extends DomainResource implements Serializable- serialVersionUID:
- 683771126L
-
Serialized Fields
-
appointmentRequired
BooleanType appointmentRequired
Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service. -
availabilityExceptions
StringType availabilityExceptions
A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. -
availableTime
List<HealthcareService.HealthcareServiceAvailableTimeComponent> availableTime
A collection of times that the Service Site is available. -
characteristic
List<CodeableConcept> characteristic
Collection of characteristics (attributes). -
comment
StringType comment
Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName. -
coverageArea
List<Reference> coverageArea
The location(s) that this service is available to (not where the service is provided). -
coverageAreaTarget
List<Location> coverageAreaTarget
The actual objects that are the target of the reference (The location(s) that this service is available to (not where the service is provided).) -
eligibility
CodeableConcept eligibility
Does this service have specific eligibility requirements that need to be met in order to use the service? -
eligibilityNote
StringType eligibilityNote
Describes the eligibility conditions for the service. -
extraDetails
StringType extraDetails
Extra details about the service that can't be placed in the other fields. -
identifier
List<Identifier> identifier
External identifiers for this item. -
location
Reference location
The location where this healthcare service may be provided. -
locationTarget
Location locationTarget
The actual object that is the target of the reference (The location where this healthcare service may be provided.) -
notAvailable
List<HealthcareService.HealthcareServiceNotAvailableComponent> notAvailable
The HealthcareService is not available during this period of time due to the provided reason. -
photo
Attachment photo
If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. -
programName
List<StringType> programName
Program Names that can be used to categorize the service. -
providedBy
Reference providedBy
The organization that provides this healthcare service. -
providedByTarget
Organization providedByTarget
The actual object that is the target of the reference (The organization that provides this healthcare service.) -
publicKey
StringType publicKey
The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available. -
referralMethod
List<CodeableConcept> referralMethod
Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required. -
serviceCategory
CodeableConcept serviceCategory
Identifies the broad category of service being performed or delivered. -
serviceName
StringType serviceName
Further description of the service as it would be presented to a consumer while searching. -
serviceProvisionCode
List<CodeableConcept> serviceProvisionCode
The code(s) that detail the conditions under which the healthcare service is available/offered. -
serviceType
List<HealthcareService.ServiceTypeComponent> serviceType
A specific type of service that may be delivered or performed. -
telecom
List<ContactPoint> telecom
List of contacts related to this specific healthcare service.
-
-
Class org.hl7.fhir.dstu2.model.HealthcareService.DaysOfWeekEnumFactory
class DaysOfWeekEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.HealthcareService.HealthcareServiceAvailableTimeComponent
class HealthcareServiceAvailableTimeComponent extends BackboneElement implements Serializable- serialVersionUID:
- -2139510127L
-
Serialized Fields
-
allDay
BooleanType allDay
Is this always available? (hence times are irrelevant) e.g. 24 hour service. -
availableEndTime
TimeType availableEndTime
The closing time of day. Note: If the AllDay flag is set, then this time is ignored. -
availableStartTime
TimeType availableStartTime
The opening time of day. Note: If the AllDay flag is set, then this time is ignored. -
daysOfWeek
List<Enumeration<HealthcareService.DaysOfWeek>> daysOfWeek
Indicates which days of the week are available between the start and end Times.
-
-
Class org.hl7.fhir.dstu2.model.HealthcareService.HealthcareServiceNotAvailableComponent
class HealthcareServiceNotAvailableComponent extends BackboneElement implements Serializable- serialVersionUID:
- 310849929L
-
Serialized Fields
-
description
StringType description
The reason that can be presented to the user as to why this time is not available. -
during
Period during
Service is not available (seasonally or for a public holiday) from this date.
-
-
Class org.hl7.fhir.dstu2.model.HealthcareService.ServiceTypeComponent
class ServiceTypeComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1703986174L
-
Serialized Fields
-
specialty
List<CodeableConcept> specialty
Collection of specialties handled by the service site. This is more of a medical term. -
type
CodeableConcept type
The specific type of service being delivered or performed.
-
-
Class org.hl7.fhir.dstu2.model.HumanName
class HumanName extends Type implements Serializable- serialVersionUID:
- -210174642L
-
Serialized Fields
-
family
List<StringType> family
The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. -
given
List<StringType> given
Given name. -
period
Period period
Indicates the period of time when this name was valid for the named person. -
prefix
List<StringType> prefix
Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. -
suffix
List<StringType> suffix
Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. -
text
StringType text
A full text representation of the name. -
use
Enumeration<HumanName.NameUse> use
Identifies the purpose for this name.
-
-
Class org.hl7.fhir.dstu2.model.HumanName.NameUseEnumFactory
class NameUseEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Identifier
class Identifier extends Type implements Serializable- serialVersionUID:
- -478840981L
-
Serialized Fields
-
assigner
Reference assigner
Organization that issued/manages the identifier. -
assignerTarget
Organization assignerTarget
The actual object that is the target of the reference (Organization that issued/manages the identifier.) -
period
Period period
Time period during which identifier is/was valid for use. -
system
UriType system
Establishes the namespace in which set of possible id values is unique. -
type
CodeableConcept type
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. -
use
Enumeration<Identifier.IdentifierUse> use
The purpose of this identifier. -
value
StringType value
The portion of the identifier typically displayed to the user and which is unique within the context of the system.
-
-
Class org.hl7.fhir.dstu2.model.Identifier.IdentifierUseEnumFactory
class IdentifierUseEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.IdType
class IdType extends UriType implements Serializable- serialVersionUID:
- 2L
-
Class org.hl7.fhir.dstu2.model.ImagingObjectSelection
class ImagingObjectSelection extends DomainResource implements Serializable- serialVersionUID:
- -1961832713L
-
Serialized Fields
-
author
Reference author
Author of ImagingObjectSelection. It can be a human author or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attach in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion. -
authoringTime
DateTimeType authoringTime
Date and time when the selection of the referenced instances were made. It is (typically) different from the creation date of the selection resource, and from dates associated with the referenced instances (e.g. capture time of the referenced image). -
authorTarget
Resource authorTarget
The actual object that is the target of the reference (Author of ImagingObjectSelection. It can be a human author or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attach in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion.) -
description
StringType description
Text description of the DICOM SOP instances selected in the ImagingObjectSelection. This should be aligned with the content of the title element, and can provide further explanation of the SOP instances in the selection. -
patient
Reference patient
A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingObjectSelection. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingObjectSelection.) -
study
List<ImagingObjectSelection.StudyComponent> study
Study identity and locating information of the DICOM SOP instances in the selection. -
title
CodeableConcept title
The reason for, or significance of, the selection of objects referenced in the resource. -
uid
OidType uid
Instance UID of the DICOM KOS SOP Instances represented in this resource.
-
-
Class org.hl7.fhir.dstu2.model.ImagingObjectSelection.FramesComponent
class FramesComponent extends BackboneElement implements Serializable- serialVersionUID:
- -2068206970L
-
Serialized Fields
-
frameNumbers
List<UnsignedIntType> frameNumbers
The frame numbers in the frame set. -
url
UriType url
WADO-RS URL to retrieve the DICOM frames.
-
-
Class org.hl7.fhir.dstu2.model.ImagingObjectSelection.InstanceComponent
class InstanceComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1641180916L
-
Serialized Fields
-
frames
List<ImagingObjectSelection.FramesComponent> frames
Identity and location information of the frames in the selected instance. -
sopClass
OidType sopClass
SOP class UID of the selected instance. -
uid
OidType uid
SOP Instance UID of the selected instance. -
url
UriType url
WADO-RS URL to retrieve the DICOM SOP Instance.
-
-
Class org.hl7.fhir.dstu2.model.ImagingObjectSelection.SeriesComponent
class SeriesComponent extends BackboneElement implements Serializable- serialVersionUID:
- 229247770L
-
Serialized Fields
-
instance
List<ImagingObjectSelection.InstanceComponent> instance
Identity and locating information of the selected DICOM SOP instances. -
uid
OidType uid
Series instance UID of the SOP instances in the selection. -
url
UriType url
WADO-RS URL to retrieve the series. Note that this URL retrieves all SOP instances of the series not only those in the selection.
-
-
Class org.hl7.fhir.dstu2.model.ImagingObjectSelection.StudyComponent
class StudyComponent extends BackboneElement implements Serializable- serialVersionUID:
- 341246743L
-
Serialized Fields
-
imagingStudy
Reference imagingStudy
Reference to the Imaging Study in FHIR form. -
imagingStudyTarget
ImagingStudy imagingStudyTarget
The actual object that is the target of the reference (Reference to the Imaging Study in FHIR form.) -
series
List<ImagingObjectSelection.SeriesComponent> series
Series identity and locating information of the DICOM SOP instances in the selection. -
uid
OidType uid
Study instance UID of the SOP instances in the selection. -
url
UriType url
WADO-RS URL to retrieve the study. Note that this URL retrieves all SOP instances of the study, not only those in the selection.
-
-
Class org.hl7.fhir.dstu2.model.ImagingStudy
class ImagingStudy extends DomainResource implements Serializable- serialVersionUID:
- 1895046380L
-
Serialized Fields
-
accession
Identifier accession
Accession Number is an identifier related to some aspect of imaging workflow and data management. Usage may vary across different institutions. See for instance [IHE Radiology Technical Framework Volume 1 Appendix A](http://www.ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Rev13.0_Vol1_FT_2014-07-30.pdf). -
availability
Enumeration<ImagingStudy.InstanceAvailability> availability
Availability of study (online, offline or nearline). -
description
StringType description
Institution-generated description or classification of the Study performed. -
identifier
List<Identifier> identifier
Other identifiers for the study. -
interpreter
Reference interpreter
Who read the study and interpreted the images or other content. -
interpreterTarget
Practitioner interpreterTarget
The actual object that is the target of the reference (Who read the study and interpreted the images or other content.) -
modalityList
List<Coding> modalityList
A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19). -
numberOfInstances
UnsignedIntType numberOfInstances
Number of SOP Instances in Study. -
numberOfSeries
UnsignedIntType numberOfSeries
Number of Series in Study. -
order
List<Reference> order
A list of the diagnostic orders that resulted in this imaging study being performed. -
orderTarget
List<DiagnosticOrder> orderTarget
The actual objects that are the target of the reference (A list of the diagnostic orders that resulted in this imaging study being performed.) -
patient
Reference patient
The patient imaged in the study. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (The patient imaged in the study.) -
procedure
List<Reference> procedure
Type of procedure performed. -
procedureTarget
List<Procedure> procedureTarget
The actual objects that are the target of the reference (Type of procedure performed.) -
referrer
Reference referrer
The requesting/referring physician. -
referrerTarget
Practitioner referrerTarget
The actual object that is the target of the reference (The requesting/referring physician.) -
series
List<ImagingStudy.ImagingStudySeriesComponent> series
Each study has one or more series of images or other content. -
started
DateTimeType started
Date and Time the study started. -
uid
OidType uid
Formal identifier for the study. -
url
UriType url
WADO-RS resource where Study is available.
-
-
Class org.hl7.fhir.dstu2.model.ImagingStudy.ImagingStudySeriesComponent
class ImagingStudySeriesComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1798366943L
-
Serialized Fields
-
availability
Enumeration<ImagingStudy.InstanceAvailability> availability
Availability of series (online, offline or nearline). -
bodySite
Coding bodySite
Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed CT. -
description
StringType description
A description of the series. -
instance
List<ImagingStudy.ImagingStudySeriesInstanceComponent> instance
A single SOP Instance within the series, e.g. an image, or presentation state. -
laterality
Coding laterality
Laterality if body site is paired anatomic structure and laterality is not pre-coordinated in body site code. -
modality
Coding modality
The modality of this series sequence. -
number
UnsignedIntType number
The Numeric identifier of this series in the study. -
numberOfInstances
UnsignedIntType numberOfInstances
Number of SOP Instances in Series. -
started
DateTimeType started
The date and time the series was started. -
uid
OidType uid
Formal identifier for this series. -
url
UriType url
URI/URL specifying the location of the referenced series using WADO-RS.
-
-
Class org.hl7.fhir.dstu2.model.ImagingStudy.ImagingStudySeriesInstanceComponent
class ImagingStudySeriesInstanceComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1450403705L
-
Serialized Fields
-
content
List<Attachment> content
Content of the instance or a rendering thereof (e.g. a JPEG of an image, or an XML of a structured report). May be represented for example by inline encoding; by a URL reference to a WADO-RS service that makes the instance available; or to a FHIR Resource (e.g. Media, Document, etc.). Multiple content attachments may be used for alternate representations of the instance. -
number
UnsignedIntType number
The number of instance in the series. -
sopClass
OidType sopClass
DICOM instance type. -
title
StringType title
The description of the instance. -
type
StringType type
A human-friendly SOP Class name. -
uid
OidType uid
Formal identifier for this image or other content.
-
-
Class org.hl7.fhir.dstu2.model.ImagingStudy.InstanceAvailabilityEnumFactory
class InstanceAvailabilityEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Immunization
class Immunization extends DomainResource implements Serializable- serialVersionUID:
- 898786200L
-
Serialized Fields
-
date
DateTimeType date
Date vaccine administered or was to be administered. -
doseQuantity
SimpleQuantity doseQuantity
The quantity of vaccine product that was administered. -
encounter
Reference encounter
The visit or admission or other contact between patient and health care provider the immunization was performed as part of. -
encounterTarget
Encounter encounterTarget
The actual object that is the target of the reference (The visit or admission or other contact between patient and health care provider the immunization was performed as part of.) -
expirationDate
DateType expirationDate
Date vaccine batch expires. -
explanation
Immunization.ImmunizationExplanationComponent explanation
Reasons why a vaccine was or was not administered. -
identifier
List<Identifier> identifier
A unique identifier assigned to this immunization record. -
location
Reference location
The service delivery location where the vaccine administration occurred. -
locationTarget
Location locationTarget
The actual object that is the target of the reference (The service delivery location where the vaccine administration occurred.) -
lotNumber
StringType lotNumber
Lot number of the vaccine product. -
manufacturer
Reference manufacturer
Name of vaccine manufacturer. -
manufacturerTarget
Organization manufacturerTarget
The actual object that is the target of the reference (Name of vaccine manufacturer.) -
note
List<Annotation> note
Extra information about the immunization that is not conveyed by the other attributes. -
patient
Reference patient
The patient who either received or did not receive the immunization. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (The patient who either received or did not receive the immunization.) -
performer
Reference performer
Clinician who administered the vaccine. -
performerTarget
Practitioner performerTarget
The actual object that is the target of the reference (Clinician who administered the vaccine.) -
reaction
List<Immunization.ImmunizationReactionComponent> reaction
Categorical data indicating that an adverse event is associated in time to an immunization. -
reported
BooleanType reported
True if this administration was reported rather than directly administered. -
requester
Reference requester
Clinician who ordered the vaccination. -
requesterTarget
Practitioner requesterTarget
The actual object that is the target of the reference (Clinician who ordered the vaccination.) -
route
CodeableConcept route
The path by which the vaccine product is taken into the body. -
site
CodeableConcept site
Body site where vaccine was administered. -
status
CodeType status
Indicates the current status of the vaccination event. -
vaccinationProtocol
List<Immunization.ImmunizationVaccinationProtocolComponent> vaccinationProtocol
Contains information about the protocol(s) under which the vaccine was administered. -
vaccineCode
CodeableConcept vaccineCode
Vaccine that was administered or was to be administered. -
wasNotGiven
BooleanType wasNotGiven
Indicates if the vaccination was or was not given.
-
-
Class org.hl7.fhir.dstu2.model.Immunization.ImmunizationExplanationComponent
class ImmunizationExplanationComponent extends BackboneElement implements Serializable- serialVersionUID:
- -539821866L
-
Serialized Fields
-
reason
List<CodeableConcept> reason
Reasons why a vaccine was administered. -
reasonNotGiven
List<CodeableConcept> reasonNotGiven
Reason why a vaccine was not administered.
-
-
Class org.hl7.fhir.dstu2.model.Immunization.ImmunizationReactionComponent
class ImmunizationReactionComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1297668556L
-
Serialized Fields
-
date
DateTimeType date
Date of reaction to the immunization. -
detail
Reference detail
Details of the reaction. -
detailTarget
Observation detailTarget
The actual object that is the target of the reference (Details of the reaction.) -
reported
BooleanType reported
Self-reported indicator.
-
-
Class org.hl7.fhir.dstu2.model.Immunization.ImmunizationVaccinationProtocolComponent
class ImmunizationVaccinationProtocolComponent extends BackboneElement implements Serializable- serialVersionUID:
- 386814037L
-
Serialized Fields
-
authority
Reference authority
Indicates the authority who published the protocol. E.g. ACIP. -
authorityTarget
Organization authorityTarget
The actual object that is the target of the reference (Indicates the authority who published the protocol. E.g. ACIP.) -
description
StringType description
Contains the description about the protocol under which the vaccine was administered. -
doseSequence
PositiveIntType doseSequence
Nominal position in a series. -
doseStatus
CodeableConcept doseStatus
Indicates if the immunization event should "count" against the protocol. -
doseStatusReason
CodeableConcept doseStatusReason
Provides an explanation as to why an immunization event should or should not count against the protocol. -
series
StringType series
One possible path to achieve presumed immunity against a disease - within the context of an authority. -
seriesDoses
PositiveIntType seriesDoses
The recommended number of doses to achieve immunity. -
targetDisease
List<CodeableConcept> targetDisease
The targeted disease.
-
-
Class org.hl7.fhir.dstu2.model.ImmunizationRecommendation
class ImmunizationRecommendation extends DomainResource implements Serializable- serialVersionUID:
- 641058495L
-
Serialized Fields
-
identifier
List<Identifier> identifier
A unique identifier assigned to this particular recommendation record. -
patient
Reference patient
The patient for whom the recommendations are for. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (The patient for whom the recommendations are for.) -
recommendation
List<ImmunizationRecommendation.ImmunizationRecommendationRecommendationComponent> recommendation
Vaccine administration recommendations.
-
-
Class org.hl7.fhir.dstu2.model.ImmunizationRecommendation.ImmunizationRecommendationRecommendationComponent
class ImmunizationRecommendationRecommendationComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1501347482L
-
Serialized Fields
-
date
DateTimeType date
The date the immunization recommendation was created. -
dateCriterion
List<ImmunizationRecommendation.ImmunizationRecommendationRecommendationDateCriterionComponent> dateCriterion
Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc. -
doseNumber
PositiveIntType doseNumber
This indicates the next recommended dose number (e.g. dose 2 is the next recommended dose). -
forecastStatus
CodeableConcept forecastStatus
Vaccine administration status. -
protocol
ImmunizationRecommendation.ImmunizationRecommendationRecommendationProtocolComponent protocol
Contains information about the protocol under which the vaccine was administered. -
supportingImmunization
List<Reference> supportingImmunization
Immunization event history that supports the status and recommendation. -
supportingImmunizationTarget
List<Immunization> supportingImmunizationTarget
The actual objects that are the target of the reference (Immunization event history that supports the status and recommendation.) -
supportingPatientInformation
List<Reference> supportingPatientInformation
Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information. -
supportingPatientInformationTarget
List<Resource> supportingPatientInformationTarget
The actual objects that are the target of the reference (Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.) -
vaccineCode
CodeableConcept vaccineCode
Vaccine that pertains to the recommendation.
-
-
Class org.hl7.fhir.dstu2.model.ImmunizationRecommendation.ImmunizationRecommendationRecommendationDateCriterionComponent
class ImmunizationRecommendationRecommendationDateCriterionComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1036994566L
-
Serialized Fields
-
code
CodeableConcept code
Date classification of recommendation. For example, earliest date to give, latest date to give, etc. -
value
DateTimeType value
The date whose meaning is specified by dateCriterion.code.
-
-
Class org.hl7.fhir.dstu2.model.ImmunizationRecommendation.ImmunizationRecommendationRecommendationProtocolComponent
class ImmunizationRecommendationRecommendationProtocolComponent extends BackboneElement implements Serializable- serialVersionUID:
- -512702014L
-
Serialized Fields
-
authority
Reference authority
Indicates the authority who published the protocol. For example, ACIP. -
authorityTarget
Organization authorityTarget
The actual object that is the target of the reference (Indicates the authority who published the protocol. For example, ACIP.) -
description
StringType description
Contains the description about the protocol under which the vaccine was administered. -
doseSequence
IntegerType doseSequence
Indicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocol. -
series
StringType series
One possible path to achieve presumed immunity against a disease - within the context of an authority.
-
-
Class org.hl7.fhir.dstu2.model.ImplementationGuide
class ImplementationGuide extends DomainResource implements Serializable- serialVersionUID:
- 1150122415L
-
Serialized Fields
-
binary
List<UriType> binary
A binary file that is included in the implementation guide when it is published. -
contact
List<ImplementationGuide.ImplementationGuideContactComponent> contact
Contacts to assist a user in finding and communicating with the publisher. -
copyright
StringType copyright
A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings. -
date
DateTimeType date
The date this version of the implementation guide was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes. -
dependency
List<ImplementationGuide.ImplementationGuideDependencyComponent> dependency
Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides. -
description
StringType description
A free text natural language description of the Implementation Guide and its use. -
experimental
BooleanType experimental
This Implementation Guide was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. -
fhirVersion
IdType fhirVersion
The version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 1.0.2 for this version. -
global
List<ImplementationGuide.ImplementationGuideGlobalComponent> global
A set of profiles that all resources covered by this implementation guide must conform to. -
name
StringType name
A free text natural language name identifying the Implementation Guide. -
package_
List<ImplementationGuide.ImplementationGuidePackageComponent> package_
A logical group of resources. Logical groups can be used when building pages. -
page
ImplementationGuide.ImplementationGuidePageComponent page
A page / section in the implementation guide. The root page is the implementation guide home page. -
publisher
StringType publisher
The name of the individual or organization that published the implementation guide. -
status
Enumeration<Enumerations.ConformanceResourceStatus> status
The status of the Implementation Guide. -
url
UriType url
An absolute URL that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this implementation guide is (or will be) published. -
useContext
List<CodeableConcept> useContext
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of implementation guides. The most common use of this element is to represent the country / jurisdiction for which this implementation guide was defined. -
version
StringType version
The identifier that is used to identify this version of the Implementation Guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Implementation Guide author manually.
-
-
Class org.hl7.fhir.dstu2.model.ImplementationGuide.GuideDependencyTypeEnumFactory
class GuideDependencyTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.ImplementationGuide.GuidePageKindEnumFactory
class GuidePageKindEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.ImplementationGuide.GuideResourcePurposeEnumFactory
class GuideResourcePurposeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.ImplementationGuide.ImplementationGuideContactComponent
class ImplementationGuideContactComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1179697803L
-
Serialized Fields
-
name
StringType name
The name of an individual to contact regarding the implementation guide. -
telecom
List<ContactPoint> telecom
Contact details for individual (if a name was provided) or the publisher.
-
-
Class org.hl7.fhir.dstu2.model.ImplementationGuide.ImplementationGuideDependencyComponent
class ImplementationGuideDependencyComponent extends BackboneElement implements Serializable- serialVersionUID:
- 162447098L
-
Serialized Fields
-
type
Enumeration<ImplementationGuide.GuideDependencyType> type
How the dependency is represented when the guide is published. -
uri
UriType uri
Where the dependency is located.
-
-
Class org.hl7.fhir.dstu2.model.ImplementationGuide.ImplementationGuideGlobalComponent
class ImplementationGuideGlobalComponent extends BackboneElement implements Serializable- serialVersionUID:
- 2011731959L
-
Serialized Fields
-
profile
Reference profile
A reference to the profile that all instances must conform to. -
profileTarget
StructureDefinition profileTarget
The actual object that is the target of the reference (A reference to the profile that all instances must conform to.) -
type
CodeType type
The type of resource that all instances must conform to.
-
-
Class org.hl7.fhir.dstu2.model.ImplementationGuide.ImplementationGuidePackageComponent
class ImplementationGuidePackageComponent extends BackboneElement implements Serializable- serialVersionUID:
- -701846580L
-
Serialized Fields
-
description
StringType description
Human readable text describing the package. -
name
StringType name
The name for the group, as used in page.package. -
resource
List<ImplementationGuide.ImplementationGuidePackageResourceComponent> resource
A resource that is part of the implementation guide. Conformance resources (value set, structure definition, conformance statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.
-
-
Class org.hl7.fhir.dstu2.model.ImplementationGuide.ImplementationGuidePackageResourceComponent
class ImplementationGuidePackageResourceComponent extends BackboneElement implements Serializable- serialVersionUID:
- 428339533L
-
Serialized Fields
-
acronym
StringType acronym
A short code that may be used to identify the resource throughout the implementation guide. -
description
StringType description
A description of the reason that a resource has been included in the implementation guide. -
exampleFor
Reference exampleFor
Another resource that this resource is an example for. This is mostly used for resources that are included as examples of StructureDefinitions. -
exampleForTarget
StructureDefinition exampleForTarget
The actual object that is the target of the reference (Another resource that this resource is an example for. This is mostly used for resources that are included as examples of StructureDefinitions.) -
name
StringType name
A human assigned name for the resource. All resources SHOULD have a name, but the name may be extracted from the resource (e.g. ValueSet.name). -
purpose
Enumeration<ImplementationGuide.GuideResourcePurpose> purpose
Why the resource is included in the guide. -
source
Type source
Where this resource is found.
-
-
Class org.hl7.fhir.dstu2.model.ImplementationGuide.ImplementationGuidePageComponent
class ImplementationGuidePageComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1620890043L
-
Serialized Fields
-
format
CodeType format
The format of the page. -
kind
Enumeration<ImplementationGuide.GuidePageKind> kind
The kind of page that this is. Some pages are autogenerated (list, example), and other kinds are of interest so that tools can navigate the user to the page of interest. -
name
StringType name
A short name used to represent this page in navigational structures such as table of contents, bread crumbs, etc. -
package_
List<StringType> package_
For constructed pages, a list of packages to include in the page (or else empty for everything). -
page
List<ImplementationGuide.ImplementationGuidePageComponent> page
Nested Pages/Sections under this page. -
source
UriType source
The source address for the page. -
type
List<CodeType> type
For constructed pages, what kind of resources to include in the list.
-
-
Class org.hl7.fhir.dstu2.model.InstantType
class InstantType extends BaseDateTimeType implements Serializable- serialVersionUID:
- 3L
-
Class org.hl7.fhir.dstu2.model.IntegerType
- serialVersionUID:
- 3L
-
Class org.hl7.fhir.dstu2.model.List_
class List_ extends DomainResource implements Serializable- serialVersionUID:
- 1819128642L
-
Serialized Fields
-
code
CodeableConcept code
This code defines the purpose of the list - why it was created. -
date
DateTimeType date
The date that the list was prepared. -
emptyReason
CodeableConcept emptyReason
If the list is empty, why the list is empty. -
encounter
Reference encounter
The encounter that is the context in which this list was created. -
encounterTarget
Encounter encounterTarget
The actual object that is the target of the reference (The encounter that is the context in which this list was created.) -
entry
List<List_.ListEntryComponent> entry
Entries in this list. -
identifier
List<Identifier> identifier
Identifier for the List assigned for business purposes outside the context of FHIR. -
mode
Enumeration<List_.ListMode> mode
How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. -
note
StringType note
Comments that apply to the overall list. -
orderedBy
CodeableConcept orderedBy
What order applies to the items in the list. -
source
Reference source
The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list. -
sourceTarget
Resource sourceTarget
The actual object that is the target of the reference (The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.) -
status
Enumeration<List_.ListStatus> status
Indicates the current state of this list. -
subject
Reference subject
The common subject (or patient) of the resources that are in the list, if there is one. -
subjectTarget
Resource subjectTarget
The actual object that is the target of the reference (The common subject (or patient) of the resources that are in the list, if there is one.) -
title
StringType title
A label for the list assigned by the author.
-
-
Class org.hl7.fhir.dstu2.model.List_.ListEntryComponent
class ListEntryComponent extends BackboneElement implements Serializable- serialVersionUID:
- -758164425L
-
Serialized Fields
-
date
DateTimeType date
When this item was added to the list. -
deleted
BooleanType deleted
True if this item is marked as deleted in the list. -
flag
CodeableConcept flag
The flag allows the system constructing the list to indicate the role and significance of the item in the list. -
item
Reference item
A reference to the actual resource from which data was derived. -
itemTarget
Resource itemTarget
The actual object that is the target of the reference (A reference to the actual resource from which data was derived.)
-
-
Class org.hl7.fhir.dstu2.model.List_.ListModeEnumFactory
class ListModeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.List_.ListStatusEnumFactory
class ListStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Location
class Location extends DomainResource implements Serializable- serialVersionUID:
- -2100435761L
-
Serialized Fields
-
address
Address address
Physical location. -
description
StringType description
Description of the Location, which helps in finding or referencing the place. -
identifier
List<Identifier> identifier
Unique code or number identifying the location to its users. -
managingOrganization
Reference managingOrganization
The organization responsible for the provisioning and upkeep of the location. -
managingOrganizationTarget
Organization managingOrganizationTarget
The actual object that is the target of the reference (The organization responsible for the provisioning and upkeep of the location.) -
mode
Enumeration<Location.LocationMode> mode
Indicates whether a resource instance represents a specific location or a class of locations. -
name
StringType name
Name of the location as used by humans. Does not need to be unique. -
partOf
Reference partOf
Another Location which this Location is physically part of. -
partOfTarget
Location partOfTarget
The actual object that is the target of the reference (Another Location which this Location is physically part of.) -
physicalType
CodeableConcept physicalType
Physical form of the location, e.g. building, room, vehicle, road. -
position
Location.LocationPositionComponent position
The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). -
status
Enumeration<Location.LocationStatus> status
active | suspended | inactive. -
telecom
List<ContactPoint> telecom
The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites. -
type
CodeableConcept type
Indicates the type of function performed at the location.
-
-
Class org.hl7.fhir.dstu2.model.Location.LocationModeEnumFactory
class LocationModeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Location.LocationPositionComponent
class LocationPositionComponent extends BackboneElement implements Serializable- serialVersionUID:
- -74276134L
-
Serialized Fields
-
altitude
DecimalType altitude
Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below). -
latitude
DecimalType latitude
Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below). -
longitude
DecimalType longitude
Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).
-
-
Class org.hl7.fhir.dstu2.model.Location.LocationStatusEnumFactory
class LocationStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.MarkdownType
class MarkdownType extends StringType implements Serializable- serialVersionUID:
- 3L
-
Class org.hl7.fhir.dstu2.model.Media
class Media extends DomainResource implements Serializable- serialVersionUID:
- -280764739L
-
Serialized Fields
-
content
Attachment content
The actual content of the media - inline or by direct reference to the media source file. -
deviceName
StringType deviceName
The name of the device / manufacturer of the device that was used to make the recording. -
duration
UnsignedIntType duration
The duration of the recording in seconds - for audio and video. -
frames
PositiveIntType frames
The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required. -
height
PositiveIntType height
Height of the image in pixels (photo/video). -
identifier
List<Identifier> identifier
Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers. -
operator
Reference operator
The person who administered the collection of the image. -
operatorTarget
Practitioner operatorTarget
The actual object that is the target of the reference (The person who administered the collection of the image.) -
subject
Reference subject
Who/What this Media is a record of. -
subjectTarget
Resource subjectTarget
The actual object that is the target of the reference (Who/What this Media is a record of.) -
subtype
CodeableConcept subtype
Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality. -
type
Enumeration<Media.DigitalMediaType> type
Whether the media is a photo (still image), an audio recording, or a video recording. -
view
CodeableConcept view
The name of the imaging view e.g. Lateral or Antero-posterior (AP). -
width
PositiveIntType width
Width of the image in pixels (photo/video).
-
-
Class org.hl7.fhir.dstu2.model.Media.DigitalMediaTypeEnumFactory
class DigitalMediaTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Medication
class Medication extends DomainResource implements Serializable- serialVersionUID:
- 859308699L
-
Serialized Fields
-
code
CodeableConcept code
A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. -
isBrand
BooleanType isBrand
Set to true if the item is attributable to a specific manufacturer. -
manufacturer
Reference manufacturer
Describes the details of the manufacturer. -
manufacturerTarget
Organization manufacturerTarget
The actual object that is the target of the reference (Describes the details of the manufacturer.) -
package_
Medication.MedicationPackageComponent package_
Information that only applies to packages (not products). -
product
Medication.MedicationProductComponent product
Information that only applies to products (not packages).
-
-
Class org.hl7.fhir.dstu2.model.Medication.MedicationPackageComponent
class MedicationPackageComponent extends BackboneElement implements Serializable- serialVersionUID:
- 503772472L
-
Serialized Fields
-
container
CodeableConcept container
The kind of container that this package comes as. -
content
List<Medication.MedicationPackageContentComponent> content
A set of components that go to make up the described item.
-
-
Class org.hl7.fhir.dstu2.model.Medication.MedicationPackageContentComponent
class MedicationPackageContentComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1150048030L
-
Serialized Fields
-
amount
SimpleQuantity amount
The amount of the product that is in the package. -
item
Reference item
Identifies one of the items in the package. -
itemTarget
Medication itemTarget
The actual object that is the target of the reference (Identifies one of the items in the package.)
-
-
Class org.hl7.fhir.dstu2.model.Medication.MedicationProductBatchComponent
class MedicationProductBatchComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1982738755L
-
Serialized Fields
-
expirationDate
DateTimeType expirationDate
When this specific batch of product will expire. -
lotNumber
StringType lotNumber
The assigned lot number of a batch of the specified product.
-
-
Class org.hl7.fhir.dstu2.model.Medication.MedicationProductComponent
class MedicationProductComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1132853671L
-
Serialized Fields
-
batch
List<Medication.MedicationProductBatchComponent> batch
Information about a group of medication produced or packaged from one production run. -
form
CodeableConcept form
Describes the form of the item. Powder; tablets; carton. -
ingredient
List<Medication.MedicationProductIngredientComponent> ingredient
Identifies a particular constituent of interest in the product.
-
-
Class org.hl7.fhir.dstu2.model.Medication.MedicationProductIngredientComponent
class MedicationProductIngredientComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1217232889L
-
Serialized Fields
-
amount
Ratio amount
Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. -
item
Reference item
The actual ingredient - either a substance (simple ingredient) or another medication. -
itemTarget
Resource itemTarget
The actual object that is the target of the reference (The actual ingredient - either a substance (simple ingredient) or another medication.)
-
-
Class org.hl7.fhir.dstu2.model.MedicationAdministration
class MedicationAdministration extends DomainResource implements Serializable- serialVersionUID:
- -669616345L
-
Serialized Fields
-
device
List<Reference> device
The device used in administering the medication to the patient. For example, a particular infusion pump. -
deviceTarget
List<Device> deviceTarget
The actual objects that are the target of the reference (The device used in administering the medication to the patient. For example, a particular infusion pump.) -
dosage
MedicationAdministration.MedicationAdministrationDosageComponent dosage
Describes the medication dosage information details e.g. dose, rate, site, route, etc. -
effectiveTime
Type effectiveTime
A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate. -
encounter
Reference encounter
The visit, admission or other contact between patient and health care provider the medication administration was performed as part of. -
encounterTarget
Encounter encounterTarget
The actual object that is the target of the reference (The visit, admission or other contact between patient and health care provider the medication administration was performed as part of.) -
identifier
List<Identifier> identifier
External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated. -
medication
Type medication
Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. -
note
StringType note
Extra information about the medication administration that is not conveyed by the other attributes. -
patient
Reference patient
The person or animal receiving the medication. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (The person or animal receiving the medication.) -
practitioner
Reference practitioner
The individual who was responsible for giving the medication to the patient. -
practitionerTarget
Resource practitionerTarget
The actual object that is the target of the reference (The individual who was responsible for giving the medication to the patient.) -
prescription
Reference prescription
The original request, instruction or authority to perform the administration. -
prescriptionTarget
MedicationOrder prescriptionTarget
The actual object that is the target of the reference (The original request, instruction or authority to perform the administration.) -
reasonGiven
List<CodeableConcept> reasonGiven
A code indicating why the medication was given. -
reasonNotGiven
List<CodeableConcept> reasonNotGiven
A code indicating why the administration was not performed. -
status
Enumeration<MedicationAdministration.MedicationAdministrationStatus> status
Will generally be set to show that the administration has been completed. For some long running administrations such as infusions it is possible for an administration to be started but not completed or it may be paused while some other process is under way. -
wasNotGiven
BooleanType wasNotGiven
Set this to true if the record is saying that the medication was NOT administered.
-
-
Class org.hl7.fhir.dstu2.model.MedicationAdministration.MedicationAdministrationDosageComponent
class MedicationAdministrationDosageComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1772198879L
-
Serialized Fields
-
method
CodeableConcept method
A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV. -
quantity
SimpleQuantity quantity
The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection. -
rate
Type rate
Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Currently we do not specify a default of '1' in the denominator, but this is being discussed. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. -
route
CodeableConcept route
A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc. -
site
Type site
A coded specification of the anatomic site where the medication first entered the body. For example, "left arm". -
text
StringType text
Free text dosage instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication.
-
-
Class org.hl7.fhir.dstu2.model.MedicationAdministration.MedicationAdministrationStatusEnumFactory
class MedicationAdministrationStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.MedicationDispense
class MedicationDispense extends DomainResource implements Serializable- serialVersionUID:
- -2071218407L
-
Serialized Fields
-
authorizingPrescription
List<Reference> authorizingPrescription
Indicates the medication order that is being dispensed against. -
authorizingPrescriptionTarget
List<MedicationOrder> authorizingPrescriptionTarget
The actual objects that are the target of the reference (Indicates the medication order that is being dispensed against.) -
daysSupply
SimpleQuantity daysSupply
The amount of medication expressed as a timing amount. -
destination
Reference destination
Identification of the facility/location where the medication was shipped to, as part of the dispense event. -
destinationTarget
Location destinationTarget
The actual object that is the target of the reference (Identification of the facility/location where the medication was shipped to, as part of the dispense event.) -
dispenser
Reference dispenser
The individual responsible for dispensing the medication. -
dispenserTarget
Practitioner dispenserTarget
The actual object that is the target of the reference (The individual responsible for dispensing the medication.) -
dosageInstruction
List<MedicationDispense.MedicationDispenseDosageInstructionComponent> dosageInstruction
Indicates how the medication is to be used by the patient. -
identifier
Identifier identifier
Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR. -
medication
Type medication
Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. -
note
StringType note
Extra information about the dispense that could not be conveyed in the other attributes. -
patient
Reference patient
A link to a resource representing the person to whom the medication will be given. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (A link to a resource representing the person to whom the medication will be given.) -
quantity
SimpleQuantity quantity
The amount of medication that has been dispensed. Includes unit of measure. -
receiver
List<Reference> receiver
Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional. -
receiverTarget
List<Resource> receiverTarget
The actual objects that are the target of the reference (Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.) -
status
Enumeration<MedicationDispense.MedicationDispenseStatus> status
A code specifying the state of the set of dispense events. -
substitution
MedicationDispense.MedicationDispenseSubstitutionComponent substitution
Indicates whether or not substitution was made as part of the dispense. In some cases substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. -
type
CodeableConcept type
Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. -
whenHandedOver
DateTimeType whenHandedOver
The time the dispensed product was provided to the patient or their representative. -
whenPrepared
DateTimeType whenPrepared
The time when the dispensed product was packaged and reviewed.
-
-
Class org.hl7.fhir.dstu2.model.MedicationDispense.MedicationDispenseDosageInstructionComponent
class MedicationDispenseDosageInstructionComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1470136646L
-
Serialized Fields
-
additionalInstructions
CodeableConcept additionalInstructions
Additional instructions such as "Swallow with plenty of water" which may or may not be coded. -
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). Specifically if 'boolean' datatype is selected, then the following logic applies: If set to True, this indicates that the medication is only taken when needed, within the specified schedule. -
dose
Type dose
The amount of therapeutic or other substance given at one administration event. -
maxDosePerPeriod
Ratio maxDosePerPeriod
The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time, e.g. 1000mg in 24 hours. -
method
CodeableConcept method
A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. -
rate
Type rate
Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Currently we do not specify a default of '1' in the denominator, but this is being discussed. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. -
route
CodeableConcept route
A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject. -
site
Type site
A coded specification of the anatomic site where the medication first enters the body. -
text
StringType text
Free text dosage instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. -
timing
Timing timing
The timing schedule for giving the medication to the patient. 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".
-
-
Class org.hl7.fhir.dstu2.model.MedicationDispense.MedicationDispenseStatusEnumFactory
class MedicationDispenseStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.MedicationDispense.MedicationDispenseSubstitutionComponent
class MedicationDispenseSubstitutionComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1218245830L
-
Serialized Fields
-
reason
List<CodeableConcept> reason
Indicates the reason for the substitution of (or lack of substitution) from what was prescribed. -
responsibleParty
List<Reference> responsibleParty
The person or organization that has primary responsibility for the substitution. -
responsiblePartyTarget
List<Practitioner> responsiblePartyTarget
The actual objects that are the target of the reference (The person or organization that has primary responsibility for the substitution.) -
type
CodeableConcept type
A code signifying whether a different drug was dispensed from what was prescribed.
-
-
Class org.hl7.fhir.dstu2.model.MedicationOrder
class MedicationOrder extends DomainResource implements Serializable- serialVersionUID:
- 619326051L
-
Serialized Fields
-
dateEnded
DateTimeType dateEnded
The date (and perhaps time) when the prescription was stopped. -
dateWritten
DateTimeType dateWritten
The date (and perhaps time) when the prescription was written. -
dispenseRequest
MedicationOrder.MedicationOrderDispenseRequestComponent dispenseRequest
Indicates the specific details for the dispense or medication supply part of a medication order (also known as a Medication Prescription). Note that this information is NOT always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department. -
dosageInstruction
List<MedicationOrder.MedicationOrderDosageInstructionComponent> dosageInstruction
Indicates how the medication is to be used by the patient. -
encounter
Reference encounter
A link to a resource that identifies the particular occurrence of contact between patient and health care provider. -
encounterTarget
Encounter encounterTarget
The actual object that is the target of the reference (A link to a resource that identifies the particular occurrence of contact between patient and health care provider.) -
identifier
List<Identifier> identifier
External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an entire workflow process where records have to be tracked through an entire system. -
medication
Type medication
Identifies the medication being administered. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications. -
note
StringType note
Extra information about the prescription that could not be conveyed by the other attributes. -
patient
Reference patient
A link to a resource representing the person to whom the medication will be given. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (A link to a resource representing the person to whom the medication will be given.) -
prescriber
Reference prescriber
The healthcare professional responsible for authorizing the prescription. -
prescriberTarget
Practitioner prescriberTarget
The actual object that is the target of the reference (The healthcare professional responsible for authorizing the prescription.) -
priorPrescription
Reference priorPrescription
A link to a resource representing an earlier order or prescription that this order supersedes. -
priorPrescriptionTarget
MedicationOrder priorPrescriptionTarget
The actual object that is the target of the reference (A link to a resource representing an earlier order or prescription that this order supersedes.) -
reason
Type reason
Can be the reason or the indication for writing the prescription. -
reasonEnded
CodeableConcept reasonEnded
The reason why the prescription was stopped, if it was. -
status
Enumeration<MedicationOrder.MedicationOrderStatus> status
A code specifying the state of the order. Generally this will be active or completed state. -
substitution
MedicationOrder.MedicationOrderSubstitutionComponent substitution
Indicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen, and in others it does not matter. This block explains the prescriber's intent. If nothing is specified substitution may be done.
-
-
Class org.hl7.fhir.dstu2.model.MedicationOrder.MedicationOrderDispenseRequestComponent
class MedicationOrderDispenseRequestComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1690502728L
-
Serialized Fields
-
expectedSupplyDuration
Duration expectedSupplyDuration
Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last. -
medication
Type medication
Identifies the medication being administered. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications. -
numberOfRepeatsAllowed
PositiveIntType numberOfRepeatsAllowed
An integer indicating the number of additional times (aka refills or repeats) the patient can receive the prescribed medication. Usage Notes: This integer does NOT include the original order dispense. This means that if an order indicates dispense 30 tablets plus "3 repeats", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets. -
quantity
SimpleQuantity quantity
The amount that is to be dispensed for one fill. -
validityPeriod
Period validityPeriod
This indicates the validity period of a prescription (stale dating the Prescription).
-
-
Class org.hl7.fhir.dstu2.model.MedicationOrder.MedicationOrderDosageInstructionComponent
class MedicationOrderDosageInstructionComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1470136646L
-
Serialized Fields
-
additionalInstructions
CodeableConcept additionalInstructions
Additional instructions such as "Swallow with plenty of water" which may or may not be coded. -
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
The amount of therapeutic or other substance given at one administration event. -
maxDosePerPeriod
Ratio maxDosePerPeriod
The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours. -
method
CodeableConcept method
A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV. -
rate
Type rate
Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Currently we do not specify a default of '1' in the denominator, but this is being discussed. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. -
route
CodeableConcept route
A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body. -
site
Type site
A coded specification of the anatomic site where the medication first enters the body. -
text
StringType text
Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. -
timing
Timing timing
The timing schedule for giving the medication to the patient. 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".
-
-
Class org.hl7.fhir.dstu2.model.MedicationOrder.MedicationOrderStatusEnumFactory
class MedicationOrderStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.MedicationOrder.MedicationOrderSubstitutionComponent
class MedicationOrderSubstitutionComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1693602518L
-
Serialized Fields
-
reason
CodeableConcept reason
Indicates the reason for the substitution, or why substitution must or must not be performed. -
type
CodeableConcept type
A code signifying whether a different drug should be dispensed from what was prescribed.
-
-
Class org.hl7.fhir.dstu2.model.MedicationStatement
class MedicationStatement extends DomainResource implements Serializable- serialVersionUID:
- 55795672L
-
Serialized Fields
-
dateAsserted
DateTimeType dateAsserted
The date when the medication statement was asserted by the information source. -
dosage
List<MedicationStatement.MedicationStatementDosageComponent> dosage
Indicates how the medication is/was used by the patient. -
effective
Type effective
The interval of time during which it is being asserted that the patient was taking the medication (or was not taking, when the wasNotGiven element is true). -
identifier
List<Identifier> identifier
External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated. -
informationSource
Reference informationSource
The person who provided the information about the taking of this medication. -
informationSourceTarget
Resource informationSourceTarget
The actual object that is the target of the reference (The person who provided the information about the taking of this medication.) -
medication
Type medication
Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. -
note
StringType note
Provides extra information about the medication statement that is not conveyed by the other attributes. -
patient
Reference patient
The person or animal who is/was taking the medication. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (The person or animal who is/was taking the medication.) -
reasonForUse
Type reasonForUse
A reason for why the medication is being/was taken. -
reasonNotTaken
List<CodeableConcept> reasonNotTaken
A code indicating why the medication was not taken. -
status
Enumeration<MedicationStatement.MedicationStatementStatus> status
A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally this will be active or completed. -
supportingInformation
List<Reference> supportingInformation
Allows linking the MedicationStatement to the underlying MedicationOrder, or to other information that supports the MedicationStatement. -
supportingInformationTarget
List<Resource> supportingInformationTarget
The actual objects that are the target of the reference (Allows linking the MedicationStatement to the underlying MedicationOrder, or to other information that supports the MedicationStatement.) -
wasNotTaken
BooleanType wasNotTaken
Set this to true if the record is saying that the medication was NOT taken.
-
-
Class org.hl7.fhir.dstu2.model.MedicationStatement.MedicationStatementDosageComponent
class MedicationStatementDosageComponent extends BackboneElement implements Serializable- serialVersionUID:
- 246880733L
-
Serialized Fields
-
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). Specifically if 'boolean' datatype is selected, then the following logic applies: If set to True, this indicates that the medication is only taken when needed, within the specified schedule. -
maxDosePerPeriod
Ratio maxDosePerPeriod
The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours. -
method
CodeableConcept method
A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV. -
quantity
Type quantity
The amount of therapeutic or other substance given at one administration event. -
rate
Type rate
Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Currently we do not specify a default of '1' in the denominator, but this is being discussed. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. -
route
CodeableConcept route
A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject. -
site
Type site
A coded specification of or a reference to the anatomic site where the medication first enters the body. -
text
StringType text
Free text dosage information as reported about a patient's medication use. When coded dosage information is present, the free text may still be present for display to humans. -
timing
Timing timing
The timing schedule for giving the medication to the patient. 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".
-
-
Class org.hl7.fhir.dstu2.model.MedicationStatement.MedicationStatementStatusEnumFactory
class MedicationStatementStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.MessageHeader
class MessageHeader extends DomainResource implements Serializable- serialVersionUID:
- 1429728517L
-
Serialized Fields
-
author
Reference author
The logical author of the message - the person or device that decided the described event should happen. Where there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions. -
authorTarget
Practitioner authorTarget
The actual object that is the target of the reference (The logical author of the message - the person or device that decided the described event should happen. Where there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.) -
data
List<Reference> data
The actual data of the message - a reference to the root/focus class of the event. -
dataTarget
List<Resource> dataTarget
The actual objects that are the target of the reference (The actual data of the message - a reference to the root/focus class of the event.) -
destination
List<MessageHeader.MessageDestinationComponent> destination
The destination application which the message is intended for. -
enterer
Reference enterer
The person or device that performed the data entry leading to this message. Where there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions. -
entererTarget
Practitioner entererTarget
The actual object that is the target of the reference (The person or device that performed the data entry leading to this message. Where there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.) -
event
Coding event
Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://hl7.org/fhir/message-events". -
reason
CodeableConcept reason
Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message. -
receiver
Reference receiver
Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient. -
receiverTarget
Resource receiverTarget
The actual object that is the target of the reference (Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.) -
response
MessageHeader.MessageHeaderResponseComponent response
Information about the message that this message is a response to. Only present if this message is a response. -
responsible
Reference responsible
The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party. -
responsibleTarget
Resource responsibleTarget
The actual object that is the target of the reference (The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.) -
source
MessageHeader.MessageSourceComponent source
The source application from which this message originated. -
timestamp
InstantType timestamp
The time that the message was sent.
-
-
Class org.hl7.fhir.dstu2.model.MessageHeader.MessageDestinationComponent
class MessageDestinationComponent extends BackboneElement implements Serializable- serialVersionUID:
- -2097633309L
-
Serialized Fields
-
endpoint
UriType endpoint
Indicates where the message should be routed to. -
name
StringType name
Human-readable name for the target system. -
target
Reference target
Identifies the target end system in situations where the initial message transmission is to an intermediary system. -
targetTarget
Device targetTarget
The actual object that is the target of the reference (Identifies the target end system in situations where the initial message transmission is to an intermediary system.)
-
-
Class org.hl7.fhir.dstu2.model.MessageHeader.MessageHeaderResponseComponent
class MessageHeaderResponseComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1008716838L
-
Serialized Fields
-
code
Enumeration<MessageHeader.ResponseType> code
Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not. -
details
Reference details
Full details of any issues found in the message. -
detailsTarget
OperationOutcome detailsTarget
The actual object that is the target of the reference (Full details of any issues found in the message.) -
identifier
IdType identifier
The id of the message that this message is a response to.
-
-
Class org.hl7.fhir.dstu2.model.MessageHeader.MessageSourceComponent
class MessageSourceComponent extends BackboneElement implements Serializable- serialVersionUID:
- -115878196L
-
Serialized Fields
-
contact
ContactPoint contact
An e-mail, phone, website or other contact point to use to resolve issues with message communications. -
endpoint
UriType endpoint
Identifies the routing target to send acknowledgements to. -
name
StringType name
Human-readable name for the source system. -
software
StringType software
May include configuration or other information useful in debugging. -
version
StringType version
Can convey versions of multiple systems in situations where a message passes through multiple hands.
-
-
Class org.hl7.fhir.dstu2.model.MessageHeader.ResponseTypeEnumFactory
class ResponseTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Meta
class Meta extends Type implements Serializable- serialVersionUID:
- 867134915L
-
Serialized Fields
-
lastUpdated
InstantType lastUpdated
When the resource last changed - e.g. when the version changed. -
profile
List<UriType> profile
A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. -
security
List<Coding> security
Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. -
tag
List<Coding> tag
Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. -
versionId
IdType versionId
The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.
-
-
Class org.hl7.fhir.dstu2.model.Money
class Money extends Quantity implements Serializable- serialVersionUID:
- 1069574054L
-
Class org.hl7.fhir.dstu2.model.NamingSystem
class NamingSystem extends DomainResource implements Serializable- serialVersionUID:
- -1337110053L
-
Serialized Fields
-
contact
List<NamingSystem.NamingSystemContactComponent> contact
Contacts to assist a user in finding and communicating with the publisher. -
date
DateTimeType date
The date (and optionally time) when the system was registered or published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the registration changes. -
description
StringType description
Details about what the namespace identifies including scope, granularity, version labeling, etc. -
kind
Enumeration<NamingSystem.NamingSystemType> kind
Indicates the purpose for the naming system - what kinds of things does it make unique? -
name
StringType name
The descriptive name of this particular identifier type or code system. -
publisher
StringType publisher
The name of the individual or organization that published the naming system. -
replacedBy
Reference replacedBy
For naming systems that are retired, indicates the naming system that should be used in their place (if any). -
replacedByTarget
NamingSystem replacedByTarget
The actual object that is the target of the reference (For naming systems that are retired, indicates the naming system that should be used in their place (if any).) -
responsible
StringType responsible
The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision. -
status
Enumeration<Enumerations.ConformanceResourceStatus> status
Indicates whether the naming system is "ready for use" or not. -
type
CodeableConcept type
Categorizes a naming system for easier search by grouping related naming systems. -
uniqueId
List<NamingSystem.NamingSystemUniqueIdComponent> uniqueId
Indicates how the system may be identified when referenced in electronic exchange. -
usage
StringType usage
Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc. -
useContext
List<CodeableConcept> useContext
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of naming systems.
-
-
Class org.hl7.fhir.dstu2.model.NamingSystem.NamingSystemContactComponent
class NamingSystemContactComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1179697803L
-
Serialized Fields
-
name
StringType name
The name of an individual to contact regarding the naming system. -
telecom
List<ContactPoint> telecom
Contact details for individual (if a name was provided) or the publisher.
-
-
Class org.hl7.fhir.dstu2.model.NamingSystem.NamingSystemIdentifierTypeEnumFactory
class NamingSystemIdentifierTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.NamingSystem.NamingSystemTypeEnumFactory
class NamingSystemTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.NamingSystem.NamingSystemUniqueIdComponent
class NamingSystemUniqueIdComponent extends BackboneElement implements Serializable- serialVersionUID:
- -193711840L
-
Serialized Fields
-
period
Period period
Identifies the period of time over which this identifier is considered appropriate to refer to the naming system. Outside of this window, the identifier might be non-deterministic. -
preferred
BooleanType preferred
Indicates whether this identifier is the "preferred" identifier of this type. -
type
Enumeration<NamingSystem.NamingSystemIdentifierType> type
Identifies the unique identifier scheme used for this particular identifier. -
value
StringType value
The string that should be sent over the wire to identify the code system or identifier system.
-
-
Class org.hl7.fhir.dstu2.model.Narrative
class Narrative extends BaseNarrative implements Serializable- serialVersionUID:
- 1463852859L
-
Serialized Fields
-
div
org.hl7.fhir.utilities.xhtml.XhtmlNode div
The actual narrative content, a stripped down version of XHTML. -
status
Enumeration<Narrative.NarrativeStatus> status
The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
-
-
Class org.hl7.fhir.dstu2.model.Narrative.NarrativeStatusEnumFactory
class NarrativeStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.NutritionOrder
class NutritionOrder extends DomainResource implements Serializable- serialVersionUID:
- 1139624085L
-
Serialized Fields
-
allergyIntolerance
List<Reference> allergyIntolerance
A link to a record of allergies or intolerances which should be included in the nutrition order. -
allergyIntoleranceTarget
List<AllergyIntolerance> allergyIntoleranceTarget
The actual objects that are the target of the reference (A link to a record of allergies or intolerances which should be included in the nutrition order.) -
dateTime
DateTimeType dateTime
The date and time that this nutrition order was requested. -
encounter
Reference encounter
An encounter that provides additional information about the healthcare context in which this request is made. -
encounterTarget
Encounter encounterTarget
The actual object that is the target of the reference (An encounter that provides additional information about the healthcare context in which this request is made.) -
enteralFormula
NutritionOrder.NutritionOrderEnteralFormulaComponent enteralFormula
Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity. -
excludeFoodModifier
List<CodeableConcept> excludeFoodModifier
This modifier is used to convey order-specific modifiers about the type of food that should NOT be given. These can be derived from patient allergies, intolerances, or preferences such as No Red Meat, No Soy or No Wheat or Gluten-Free. While it should not be necessary to repeat allergy or intolerance information captured in the referenced allergyIntolerance resource in the excludeFoodModifier, this element may be used to convey additional specificity related to foods that should be eliminated from the patient?s diet for any reason. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings. -
foodPreferenceModifier
List<CodeableConcept> foodPreferenceModifier
This modifier is used to convey order-specific modifiers about the type of food that should be given. These can be derived from patient allergies, intolerances, or preferences such as Halal, Vegan or Kosher. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings. -
identifier
List<Identifier> identifier
Identifiers assigned to this order by the order sender or by the order receiver. -
oralDiet
NutritionOrder.NutritionOrderOralDietComponent oralDiet
Diet given orally in contrast to enteral (tube) feeding. -
orderer
Reference orderer
The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings. -
ordererTarget
Practitioner ordererTarget
The actual object that is the target of the reference (The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.) -
patient
Reference patient
The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.) -
status
Enumeration<NutritionOrder.NutritionOrderStatus> status
The workflow status of the nutrition order/request. -
supplement
List<NutritionOrder.NutritionOrderSupplementComponent> supplement
Oral nutritional products given in order to add further nutritional value to the patient's diet.
-
-
Class org.hl7.fhir.dstu2.model.NutritionOrder.NutritionOrderEnteralFormulaAdministrationComponent
class NutritionOrderEnteralFormulaAdministrationComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1895031997L
-
Serialized Fields
-
quantity
SimpleQuantity quantity
The volume of formula to provide to the patient per the specified administration schedule. -
rate
Type rate
The rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule. -
schedule
Timing schedule
The time period and frequency at which the enteral formula should be delivered to the patient.
-
-
Class org.hl7.fhir.dstu2.model.NutritionOrder.NutritionOrderEnteralFormulaComponent
class NutritionOrderEnteralFormulaComponent extends BackboneElement implements Serializable- serialVersionUID:
- 292116061L
-
Serialized Fields
-
additiveProductName
StringType additiveProductName
The product or brand name of the type of modular component to be added to the formula. -
additiveType
CodeableConcept additiveType
Indicates the type of modular component such as protein, carbohydrate, fat or fiber to be provided in addition to or mixed with the base formula. -
administration
List<NutritionOrder.NutritionOrderEnteralFormulaAdministrationComponent> administration
Formula administration instructions as structured data. This repeating structure allows for changing the administration rate or volume over time for both bolus and continuous feeding. An example of this would be an instruction to increase the rate of continuous feeding every 2 hours. -
administrationInstruction
StringType administrationInstruction
Free text formula administration, feeding instructions or additional instructions or information. -
baseFormulaProductName
StringType baseFormulaProductName
The product or brand name of the enteral or infant formula product such as "ACME Adult Standard Formula". -
baseFormulaType
CodeableConcept baseFormulaType
The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula. -
caloricDensity
SimpleQuantity caloricDensity
The amount of energy (Calories) that the formula should provide per specified volume, typically per mL or fluid oz. For example, an infant may require a formula that provides 24 Calories per fluid ounce or an adult may require an enteral formula that provides 1.5 Calorie/mL. -
maxVolumeToDeliver
SimpleQuantity maxVolumeToDeliver
The maximum total quantity of formula that may be administered to a subject over the period of time, e.g. 1440 mL over 24 hours. -
routeofAdministration
CodeableConcept routeofAdministration
The route or physiological path of administration into the patient's gastrointestinal tract for purposes of providing the formula feeding, e.g. nasogastric tube.
-
-
Class org.hl7.fhir.dstu2.model.NutritionOrder.NutritionOrderOralDietComponent
class NutritionOrderOralDietComponent extends BackboneElement implements Serializable- serialVersionUID:
- 973058412L
-
Serialized Fields
-
fluidConsistencyType
List<CodeableConcept> fluidConsistencyType
The required consistency (e.g. honey-thick, nectar-thick, thin, thickened.) of liquids or fluids served to the patient. -
instruction
StringType instruction
Free text or additional instructions or information pertaining to the oral diet. -
nutrient
List<NutritionOrder.NutritionOrderOralDietNutrientComponent> nutrient
Class that defines the quantity and type of nutrient modifications required for the oral diet. -
schedule
List<Timing> schedule
The time period and frequency at which the diet should be given. -
texture
List<NutritionOrder.NutritionOrderOralDietTextureComponent> texture
Class that describes any texture modifications required for the patient to safely consume various types of solid foods. -
type
List<CodeableConcept> type
The kind of diet or dietary restriction such as fiber restricted diet or diabetic diet.
-
-
Class org.hl7.fhir.dstu2.model.NutritionOrder.NutritionOrderOralDietNutrientComponent
class NutritionOrderOralDietNutrientComponent extends BackboneElement implements Serializable- serialVersionUID:
- 465107295L
-
Serialized Fields
-
amount
SimpleQuantity amount
The quantity of the specified nutrient to include in diet. -
modifier
CodeableConcept modifier
The nutrient that is being modified such as carbohydrate or sodium.
-
-
Class org.hl7.fhir.dstu2.model.NutritionOrder.NutritionOrderOralDietTextureComponent
class NutritionOrderOralDietTextureComponent extends BackboneElement implements Serializable- serialVersionUID:
- -56402817L
-
Serialized Fields
-
foodType
CodeableConcept foodType
The food type(s) (e.g. meats, all foods) that the texture modification applies to. This could be all foods types. -
modifier
CodeableConcept modifier
Any texture modifications (for solid foods) that should be made, e.g. easy to chew, chopped, ground, and pureed.
-
-
Class org.hl7.fhir.dstu2.model.NutritionOrder.NutritionOrderStatusEnumFactory
class NutritionOrderStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.NutritionOrder.NutritionOrderSupplementComponent
class NutritionOrderSupplementComponent extends BackboneElement implements Serializable- serialVersionUID:
- 297545236L
-
Serialized Fields
-
instruction
StringType instruction
Free text or additional instructions or information pertaining to the oral supplement. -
productName
StringType productName
The product or brand name of the nutritional supplement such as "Acme Protein Shake". -
quantity
SimpleQuantity quantity
The amount of the nutritional supplement to be given. -
schedule
List<Timing> schedule
The time period and frequency at which the supplement(s) should be given. -
type
CodeableConcept type
The kind of nutritional supplement product required such as a high protein or pediatric clear liquid supplement.
-
-
Class org.hl7.fhir.dstu2.model.Observation
class Observation extends DomainResource implements Serializable- serialVersionUID:
- -931593572L
-
Serialized Fields
-
bodySite
CodeableConcept bodySite
Indicates the site on the subject's body where the observation was made (i.e. the target site). -
category
CodeableConcept category
A code that classifies the general type of observation being made. This is used for searching, sorting and display purposes. -
code
CodeableConcept code
Describes what was observed. Sometimes this is called the observation "name". -
comments
StringType comments
May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result. -
component
List<Observation.ObservationComponentComponent> component
Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. -
dataAbsentReason
CodeableConcept dataAbsentReason
Provides a reason why the expected value in the element Observation.value[x] is missing. -
device
Reference device
The device used to generate the observation data. -
deviceTarget
Resource deviceTarget
The actual object that is the target of the reference (The device used to generate the observation data.) -
effective
Type effective
The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. -
encounter
Reference encounter
The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. -
encounterTarget
Encounter encounterTarget
The actual object that is the target of the reference (The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.) -
identifier
List<Identifier> identifier
A unique identifier for the simple observation instance. -
interpretation
CodeableConcept interpretation
The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag. -
issued
InstantType issued
The date and time this observation was made available to providers, typically after the results have been reviewed and verified. -
method
CodeableConcept method
Indicates the mechanism used to perform the observation. -
performer
List<Reference> performer
Who was responsible for asserting the observed value as "true". -
performerTarget
List<Resource> performerTarget
The actual objects that are the target of the reference (Who was responsible for asserting the observed value as "true".) -
referenceRange
List<Observation.ObservationReferenceRangeComponent> referenceRange
Guidance on how to interpret the value by comparison to a normal or recommended range. -
related
List<Observation.ObservationRelatedComponent> related
A reference to another resource (usually another Observation but could also be a QuestionnaireAnswer) whose relationship is defined by the relationship type code. -
specimen
Reference specimen
The specimen that was used when this observation was made. -
specimenTarget
Specimen specimenTarget
The actual object that is the target of the reference (The specimen that was used when this observation was made.) -
status
Enumeration<Observation.ObservationStatus> status
The status of the result value. -
subject
Reference subject
The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject. -
subjectTarget
Resource subjectTarget
The actual object that is the target of the reference (The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.) -
value
Type value
The information determined as a result of making the observation, if the information has a simple value.
-
-
Class org.hl7.fhir.dstu2.model.Observation.ObservationComponentComponent
class ObservationComponentComponent extends BackboneElement implements Serializable- serialVersionUID:
- 946602904L
-
Serialized Fields
-
code
CodeableConcept code
Describes what was observed. Sometimes this is called the observation "code". -
dataAbsentReason
CodeableConcept dataAbsentReason
Provides a reason why the expected value in the element Observation.value[x] is missing. -
referenceRange
List<Observation.ObservationReferenceRangeComponent> referenceRange
Guidance on how to interpret the value by comparison to a normal or recommended range. -
value
Type value
The information determined as a result of making the observation, if the information has a simple value.
-
-
Class org.hl7.fhir.dstu2.model.Observation.ObservationReferenceRangeComponent
class ObservationReferenceRangeComponent extends BackboneElement implements Serializable- serialVersionUID:
- -238694788L
-
Serialized Fields
-
age
Range age
The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so. -
high
SimpleQuantity high
The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - invalid input: '<'=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3). -
low
SimpleQuantity low
The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - invalid input: '<'=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is invalid input: '<'=2.3). -
meaning
CodeableConcept meaning
Code for the meaning of the reference range. -
text
StringType text
Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of 'normals'.
-
-
Class org.hl7.fhir.dstu2.model.Observation.ObservationRelatedComponent
class ObservationRelatedComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1541802577L
-
Serialized Fields
-
target
Reference target
A reference to the observation or [[[QuestionnaireResponse]]] resource that is related to this observation. -
targetTarget
Resource targetTarget
The actual object that is the target of the reference (A reference to the observation or [[[QuestionnaireResponse]]] resource that is related to this observation.) -
type
Enumeration<Observation.ObservationRelationshipType> type
A code specifying the kind of relationship that exists with the target resource.
-
-
Class org.hl7.fhir.dstu2.model.Observation.ObservationRelationshipTypeEnumFactory
class ObservationRelationshipTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Observation.ObservationStatusEnumFactory
class ObservationStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.OidType
class OidType extends UriType implements Serializable- serialVersionUID:
- 3L
-
Class org.hl7.fhir.dstu2.model.OperationDefinition
class OperationDefinition extends DomainResource implements Serializable- serialVersionUID:
- 148203484L
-
Serialized Fields
-
base
Reference base
Indicates that this operation definition is a constraining profile on the base. -
baseTarget
OperationDefinition baseTarget
The actual object that is the target of the reference (Indicates that this operation definition is a constraining profile on the base.) -
code
CodeType code
The name used to invoke the operation. -
contact
List<OperationDefinition.OperationDefinitionContactComponent> contact
Contacts to assist a user in finding and communicating with the publisher. -
date
DateTimeType date
The date this version of the operation definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the Operation Definition changes. -
description
StringType description
A free text natural language description of the profile and its use. -
experimental
BooleanType experimental
This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. -
idempotent
BooleanType idempotent
Operations that are idempotent (see [HTTP specification definition of idempotent](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html)) may be invoked by performing an HTTP GET operation instead of a POST. -
instance
BooleanType instance
Indicates whether this operation can be invoked on a particular instance of one of the given types. -
kind
Enumeration<OperationDefinition.OperationKind> kind
Whether this is an operation or a named query. -
name
StringType name
A free text natural language name identifying the operation. -
notes
StringType notes
Additional information about how to use this operation or named query. -
parameter
List<OperationDefinition.OperationDefinitionParameterComponent> parameter
The parameters for the operation/query. -
publisher
StringType publisher
The name of the individual or organization that published the operation definition. -
requirements
StringType requirements
Explains why this operation definition is needed and why it's been constrained as it has. -
status
Enumeration<Enumerations.ConformanceResourceStatus> status
The status of the profile. -
system
BooleanType system
Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context). -
type
List<CodeType> type
Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a resource type for the context). -
url
UriType url
An absolute URL that is used to identify this operation definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this operation definition is (or will be) published. -
version
StringType version
The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.
-
-
Class org.hl7.fhir.dstu2.model.OperationDefinition.OperationDefinitionContactComponent
class OperationDefinitionContactComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1179697803L
-
Serialized Fields
-
name
StringType name
The name of an individual to contact regarding the operation definition. -
telecom
List<ContactPoint> telecom
Contact details for individual (if a name was provided) or the publisher.
-
-
Class org.hl7.fhir.dstu2.model.OperationDefinition.OperationDefinitionParameterBindingComponent
class OperationDefinitionParameterBindingComponent extends BackboneElement implements Serializable- serialVersionUID:
- 857140521L
-
Serialized Fields
-
strength
Enumeration<Enumerations.BindingStrength> strength
Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances. -
valueSet
Type valueSet
Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.
-
-
Class org.hl7.fhir.dstu2.model.OperationDefinition.OperationDefinitionParameterComponent
class OperationDefinitionParameterComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1514145741L
-
Serialized Fields
-
binding
OperationDefinition.OperationDefinitionParameterBindingComponent binding
Binds to a value set if this parameter is coded (code, Coding, CodeableConcept). -
documentation
StringType documentation
Describes the meaning or use of this parameter. -
max
StringType max
The maximum number of times this element is permitted to appear in the request or response. -
min
IntegerType min
The minimum number of times this parameter SHALL appear in the request or response. -
name
CodeType name
The name of used to identify the parameter. -
part
List<OperationDefinition.OperationDefinitionParameterComponent> part
The parts of a Tuple Parameter. -
profile
Reference profile
A profile the specifies the rules that this parameter must conform to. -
profileTarget
StructureDefinition profileTarget
The actual object that is the target of the reference (A profile the specifies the rules that this parameter must conform to.) -
type
CodeType type
The type for this parameter. -
use
Enumeration<OperationDefinition.OperationParameterUse> use
Whether this is an input or an output parameter.
-
-
Class org.hl7.fhir.dstu2.model.OperationDefinition.OperationKindEnumFactory
class OperationKindEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.OperationDefinition.OperationParameterUseEnumFactory
class OperationParameterUseEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.OperationOutcome
class OperationOutcome extends DomainResource implements Serializable- serialVersionUID:
- -152150052L
-
Serialized Fields
-
issue
List<OperationOutcome.OperationOutcomeIssueComponent> issue
An error, warning or information message that results from a system action.
-
-
Class org.hl7.fhir.dstu2.model.OperationOutcome.IssueSeverityEnumFactory
class IssueSeverityEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.OperationOutcome.IssueTypeEnumFactory
class IssueTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.OperationOutcome.OperationOutcomeIssueComponent
class OperationOutcomeIssueComponent extends BackboneElement implements Serializable- serialVersionUID:
- 930165515L
-
Serialized Fields
-
code
Enumeration<OperationOutcome.IssueType> code
Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element. -
details
CodeableConcept details
Additional details about the error. This may be a text description of the error, or a system code that identifies the error. -
diagnostics
StringType diagnostics
Additional diagnostic information about the issue. Typically, this may be a description of how a value is erroneous, or a stack dump to help trace the issue. -
location
List<StringType> location
A simple XPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised. -
severity
Enumeration<OperationOutcome.IssueSeverity> severity
Indicates whether the issue indicates a variation from successful processing.
-
-
Class org.hl7.fhir.dstu2.model.Order
class Order extends DomainResource implements Serializable- serialVersionUID:
- -1392311096L
-
Serialized Fields
-
date
DateTimeType date
When the order was made. -
detail
List<Reference> detail
What action is being ordered. -
detailTarget
List<Resource> detailTarget
The actual objects that are the target of the reference (What action is being ordered.) -
identifier
List<Identifier> identifier
Identifiers assigned to this order by the orderer or by the receiver. -
reason
Type reason
Text - why the order was made. -
source
Reference source
Who initiated the order. -
sourceTarget
Resource sourceTarget
The actual object that is the target of the reference (Who initiated the order.) -
subject
Reference subject
Patient this order is about. -
subjectTarget
Resource subjectTarget
The actual object that is the target of the reference (Patient this order is about.) -
target
Reference target
Who is intended to fulfill the order. -
targetTarget
Resource targetTarget
The actual object that is the target of the reference (Who is intended to fulfill the order.) -
when
Order.OrderWhenComponent when
When order should be fulfilled.
-
-
Class org.hl7.fhir.dstu2.model.Order.OrderWhenComponent
class OrderWhenComponent extends BackboneElement implements Serializable- serialVersionUID:
- 307115287L
-
Serialized Fields
-
code
CodeableConcept code
Code specifies when request should be done. The code may simply be a priority code. -
schedule
Timing schedule
A formal schedule.
-
-
Class org.hl7.fhir.dstu2.model.OrderResponse
class OrderResponse extends DomainResource implements Serializable- serialVersionUID:
- -856633109L
-
Serialized Fields
-
date
DateTimeType date
The date and time at which this order response was made (created/posted). -
description
StringType description
Additional description about the response - e.g. a text description provided by a human user when making decisions about the order. -
fulfillment
List<Reference> fulfillment
Links to resources that provide details of the outcome of performing the order; e.g. Diagnostic Reports in a response that is made to an order that referenced a diagnostic order. -
fulfillmentTarget
List<Resource> fulfillmentTarget
The actual objects that are the target of the reference (Links to resources that provide details of the outcome of performing the order; e.g. Diagnostic Reports in a response that is made to an order that referenced a diagnostic order.) -
identifier
List<Identifier> identifier
Identifiers assigned to this order. The identifiers are usually assigned by the system responding to the order, but they may be provided or added to by other systems. -
orderStatus
Enumeration<OrderResponse.OrderStatus> orderStatus
What this response says about the status of the original order. -
request
Reference request
A reference to the order that this is in response to. -
requestTarget
Order requestTarget
The actual object that is the target of the reference (A reference to the order that this is in response to.) -
who
Reference who
The person, organization, or device credited with making the response. -
whoTarget
Resource whoTarget
The actual object that is the target of the reference (The person, organization, or device credited with making the response.)
-
-
Class org.hl7.fhir.dstu2.model.OrderResponse.OrderStatusEnumFactory
class OrderStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Organization
class Organization extends DomainResource implements Serializable- serialVersionUID:
- -749567123L
-
Serialized Fields
-
active
BooleanType active
Whether the organization's record is still in active use. -
address
List<Address> address
An address for the organization. -
contact
List<Organization.OrganizationContactComponent> contact
Contact for the organization for a certain purpose. -
identifier
List<Identifier> identifier
Identifier for the organization that is used to identify the organization across multiple disparate systems. -
name
StringType name
A name associated with the organization. -
partOf
Reference partOf
The organization of which this organization forms a part. -
partOfTarget
Organization partOfTarget
The actual object that is the target of the reference (The organization of which this organization forms a part.) -
telecom
List<ContactPoint> telecom
A contact detail for the organization. -
type
CodeableConcept type
The kind of organization that this is.
-
-
Class org.hl7.fhir.dstu2.model.Organization.OrganizationContactComponent
class OrganizationContactComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1831121305L
-
Serialized Fields
-
address
Address address
Visiting or postal addresses for the contact. -
name
HumanName name
A name associated with the contact. -
purpose
CodeableConcept purpose
Indicates a purpose for which the contact can be reached. -
telecom
List<ContactPoint> telecom
A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.
-
-
Class org.hl7.fhir.dstu2.model.Parameters
class Parameters extends Resource implements Serializable- serialVersionUID:
- -1495940293L
-
Serialized Fields
-
parameter
List<Parameters.ParametersParameterComponent> parameter
A parameter passed to or received from the operation.
-
-
Class org.hl7.fhir.dstu2.model.Parameters.ParametersParameterComponent
class ParametersParameterComponent extends BackboneElement implements Serializable- serialVersionUID:
- -198518915L
-
Serialized Fields
-
name
StringType name
The name of the parameter (reference to the operation definition). -
part
List<Parameters.ParametersParameterComponent> part
A named part of a parameter. In many implementation context, a set of named parts is known as a "Tuple". -
resource
Resource resource
If the parameter is a whole resource. -
value
Type value
If the parameter is a data type.
-
-
Class org.hl7.fhir.dstu2.model.Patient
class Patient extends DomainResource implements Serializable- serialVersionUID:
- 2019992554L
-
Serialized Fields
-
active
BooleanType active
Whether this patient record is in active use. -
address
List<Address> address
Addresses for the individual. -
animal
Patient.AnimalComponent animal
This patient is known to be an animal. -
birthDate
DateType birthDate
The date of birth for the individual. -
careProvider
List<Reference> careProvider
Patient's nominated care provider. -
careProviderTarget
List<Resource> careProviderTarget
The actual objects that are the target of the reference (Patient's nominated care provider.) -
communication
List<Patient.PatientCommunicationComponent> communication
Languages which may be used to communicate with the patient about his or her health. -
contact
List<Patient.ContactComponent> contact
A contact party (e.g. guardian, partner, friend) for the patient. -
deceased
Type deceased
Indicates if the individual is deceased or not. -
gender
Enumeration<Enumerations.AdministrativeGender> gender
Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. -
identifier
List<Identifier> identifier
An identifier for this patient. -
link
List<Patient.PatientLinkComponent> link
Link to another patient resource that concerns the same actual patient. -
managingOrganization
Reference managingOrganization
Organization that is the custodian of the patient record. -
managingOrganizationTarget
Organization managingOrganizationTarget
The actual object that is the target of the reference (Organization that is the custodian of the patient record.) -
maritalStatus
CodeableConcept maritalStatus
This field contains a patient's most recent marital (civil) status. -
multipleBirth
Type multipleBirth
Indicates whether the patient is part of a multiple or indicates the actual birth order. -
name
List<HumanName> name
A name associated with the individual. -
photo
List<Attachment> photo
Image of the patient. -
telecom
List<ContactPoint> telecom
A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
-
-
Class org.hl7.fhir.dstu2.model.Patient.AnimalComponent
class AnimalComponent extends BackboneElement implements Serializable- serialVersionUID:
- -549738382L
-
Serialized Fields
-
breed
CodeableConcept breed
Identifies the detailed categorization of the kind of animal. -
genderStatus
CodeableConcept genderStatus
Indicates the current state of the animal's reproductive organs. -
species
CodeableConcept species
Identifies the high level taxonomic categorization of the kind of animal.
-
-
Class org.hl7.fhir.dstu2.model.Patient.ContactComponent
class ContactComponent extends BackboneElement implements Serializable- serialVersionUID:
- 364269017L
-
Serialized Fields
-
address
Address address
Address for the contact person. -
gender
Enumeration<Enumerations.AdministrativeGender> gender
Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. -
name
HumanName name
A name associated with the contact person. -
organization
Reference organization
Organization on behalf of which the contact is acting or for which the contact is working. -
organizationTarget
Organization organizationTarget
The actual object that is the target of the reference (Organization on behalf of which the contact is acting or for which the contact is working.) -
period
Period period
The period during which this contact person or organization is valid to be contacted relating to this patient. -
relationship
List<CodeableConcept> relationship
The nature of the relationship between the patient and the contact person. -
telecom
List<ContactPoint> telecom
A contact detail for the person, e.g. a telephone number or an email address.
-
-
Class org.hl7.fhir.dstu2.model.Patient.LinkTypeEnumFactory
class LinkTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Patient.PatientCommunicationComponent
class PatientCommunicationComponent extends BackboneElement implements Serializable- serialVersionUID:
- 633792918L
-
Serialized Fields
-
language
CodeableConcept language
The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. -
preferred
BooleanType preferred
Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).
-
-
Class org.hl7.fhir.dstu2.model.Patient.PatientLinkComponent
class PatientLinkComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1942104050L
-
Serialized Fields
-
other
Reference other
The other patient resource that the link refers to. -
otherTarget
Patient otherTarget
The actual object that is the target of the reference (The other patient resource that the link refers to.) -
type
Enumeration<Patient.LinkType> type
The type of link between this patient resource and another patient resource.
-
-
Class org.hl7.fhir.dstu2.model.PaymentNotice
class PaymentNotice extends DomainResource implements Serializable- serialVersionUID:
- -394826458L
-
Serialized Fields
-
created
DateTimeType created
The date when this resource was created. -
identifier
List<Identifier> identifier
The Response business identifier. -
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.) -
originalRuleset
Coding originalRuleset
The style (standard) and version of the original material which was converted into this resource. -
paymentStatus
Coding paymentStatus
The payment status, typically paid: payment sent, cleared: payment received. -
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.) -
request
Reference request
Reference of resource to reverse. -
requestTarget
Resource requestTarget
The actual object that is the target of the reference (Reference of resource to reverse.) -
response
Reference response
Reference of response to resource to reverse. -
responseTarget
Resource responseTarget
The actual object that is the target of the reference (Reference of response to resource to reverse.) -
ruleset
Coding ruleset
The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources. -
target
Reference target
The Insurer who is target of the request. -
targetTarget
Organization targetTarget
The actual object that is the target of the reference (The Insurer who is target of the request.)
-
-
Class org.hl7.fhir.dstu2.model.PaymentReconciliation
class PaymentReconciliation extends DomainResource implements Serializable- serialVersionUID:
- 454328025L
-
Serialized Fields
-
created
DateTimeType created
The date when the enclosed suite of services were performed or completed. -
detail
List<PaymentReconciliation.DetailsComponent> detail
List of individual settlement amounts and the corresponding transaction. -
disposition
StringType disposition
A description of the status of the adjudication. -
form
Coding form
The form to be used for printing the content. -
identifier
List<Identifier> identifier
The Response business identifier. -
note
List<PaymentReconciliation.NotesComponent> note
Suite of notes. -
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.) -
originalRuleset
Coding originalRuleset
The style (standard) and version of the original material which was converted into this resource. -
outcome
Enumeration<Enumerations.RemittanceOutcome> outcome
Transaction status: error, complete. -
period
Period period
The period of time for which payments have been gathered into this bulk payment for settlement. -
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
ProcessRequest requestTarget
The actual object that is the target of the reference (Original request resource reference.) -
ruleset
Coding ruleset
The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources. -
total
Money total
Total payment amount.
-
-
Class org.hl7.fhir.dstu2.model.PaymentReconciliation.DetailsComponent
class DetailsComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1644048062L
-
Serialized Fields
-
amount
Money amount
Amount paid for this detail. -
date
DateType date
The date of the invoice or financial resource. -
payee
Reference payee
The organization which is receiving the payment. -
payeeTarget
Organization payeeTarget
The actual object that is the target of the reference (The organization which is receiving the payment.) -
request
Reference request
The claim or financial resource. -
requestTarget
Resource requestTarget
The actual object that is the target of the reference (The claim or financial resource.) -
responce
Reference responce
The claim response resource. -
responceTarget
Resource responceTarget
The actual object that is the target of the reference (The claim response resource.) -
submitter
Reference submitter
The Organization which submitted the invoice or financial transaction. -
submitterTarget
Organization submitterTarget
The actual object that is the target of the reference (The Organization which submitted the invoice or financial transaction.) -
type
Coding type
Code to indicate the nature of the payment, adjustment, funds advance, etc.
-
-
Class org.hl7.fhir.dstu2.model.PaymentReconciliation.NotesComponent
class NotesComponent extends BackboneElement implements Serializable- serialVersionUID:
- 129959202L
-
Serialized Fields
-
text
StringType text
The note text. -
type
Coding type
The note purpose: Print/Display.
-
-
Class org.hl7.fhir.dstu2.model.Period
class Period extends Type implements Serializable- serialVersionUID:
- 649791751L
-
Serialized Fields
-
end
DateTimeType end
The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. -
start
DateTimeType start
The start of the period. The boundary is inclusive.
-
-
Class org.hl7.fhir.dstu2.model.Person
class Person extends DomainResource implements Serializable- serialVersionUID:
- -117464654L
-
Serialized Fields
-
active
BooleanType active
Whether this person's record is in active use. -
address
List<Address> address
One or more addresses for the person. -
birthDate
DateType birthDate
The birth date for the person. -
gender
Enumeration<Enumerations.AdministrativeGender> gender
Administrative Gender. -
identifier
List<Identifier> identifier
Identifier for a person within a particular scope. -
link
List<Person.PersonLinkComponent> link
Link to a resource that concerns the same actual person. -
managingOrganization
Reference managingOrganization
The organization that is the custodian of the person record. -
managingOrganizationTarget
Organization managingOrganizationTarget
The actual object that is the target of the reference (The organization that is the custodian of the person record.) -
name
List<HumanName> name
A name associated with the person. -
photo
Attachment photo
An image that can be displayed as a thumbnail of the person to enhance the identification of the individual. -
telecom
List<ContactPoint> telecom
A contact detail for the person, e.g. a telephone number or an email address.
-
-
Class org.hl7.fhir.dstu2.model.Person.IdentityAssuranceLevelEnumFactory
class IdentityAssuranceLevelEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Person.PersonLinkComponent
class PersonLinkComponent extends BackboneElement implements Serializable- serialVersionUID:
- 508763647L
-
Serialized Fields
-
assurance
Enumeration<Person.IdentityAssuranceLevel> assurance
Level of assurance that this link is actually associated with the target resource. -
target
Reference target
The resource to which this actual person is associated. -
targetTarget
Resource targetTarget
The actual object that is the target of the reference (The resource to which this actual person is associated.)
-
-
Class org.hl7.fhir.dstu2.model.PositiveIntType
class PositiveIntType extends IntegerType implements Serializable- serialVersionUID:
- 1686497884249402429L
-
Class org.hl7.fhir.dstu2.model.Practitioner
class Practitioner extends DomainResource implements Serializable- serialVersionUID:
- 1066276346L
-
Serialized Fields
-
active
BooleanType active
Whether this practitioner's record is in active use. -
address
List<Address> address
The postal address where the practitioner can be found or visited or to which mail can be delivered. -
birthDate
DateType birthDate
The date of birth for the practitioner. -
communication
List<CodeableConcept> communication
A language the practitioner is able to use in patient communication. -
gender
Enumeration<Enumerations.AdministrativeGender> gender
Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. -
identifier
List<Identifier> identifier
An identifier that applies to this person in this role. -
name
HumanName name
A name associated with the person. -
photo
List<Attachment> photo
Image of the person. -
practitionerRole
List<Practitioner.PractitionerPractitionerRoleComponent> practitionerRole
The list of roles/organizations that the practitioner is associated with. -
qualification
List<Practitioner.PractitionerQualificationComponent> qualification
Qualifications obtained by training and certification. -
telecom
List<ContactPoint> telecom
A contact detail for the practitioner, e.g. a telephone number or an email address.
-
-
Class org.hl7.fhir.dstu2.model.Practitioner.PractitionerPractitionerRoleComponent
class PractitionerPractitionerRoleComponent extends BackboneElement implements Serializable- serialVersionUID:
- -2146177018L
-
Serialized Fields
-
healthcareService
List<Reference> healthcareService
The list of healthcare services that this worker provides for this role's Organization/Location(s). -
healthcareServiceTarget
List<HealthcareService> healthcareServiceTarget
The actual objects that are the target of the reference (The list of healthcare services that this worker provides for this role's Organization/Location(s).) -
location
List<Reference> location
The location(s) at which this practitioner provides care. -
locationTarget
List<Location> locationTarget
The actual objects that are the target of the reference (The location(s) at which this practitioner provides care.) -
managingOrganization
Reference managingOrganization
The organization where the Practitioner performs the roles associated. -
managingOrganizationTarget
Organization managingOrganizationTarget
The actual object that is the target of the reference (The organization where the Practitioner performs the roles associated.) -
period
Period period
The period during which the person is authorized to act as a practitioner in these role(s) for the organization. -
role
CodeableConcept role
Roles which this practitioner is authorized to perform for the organization. -
specialty
List<CodeableConcept> specialty
Specific specialty of the practitioner.
-
-
Class org.hl7.fhir.dstu2.model.Practitioner.PractitionerQualificationComponent
class PractitionerQualificationComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1095219071L
-
Serialized Fields
-
code
CodeableConcept code
Coded representation of the qualification. -
identifier
List<Identifier> identifier
An identifier that applies to this person's qualification in this role. -
issuer
Reference issuer
Organization that regulates and issues the qualification. -
issuerTarget
Organization issuerTarget
The actual object that is the target of the reference (Organization that regulates and issues the qualification.) -
period
Period period
Period during which the qualification is valid.
-
-
Class org.hl7.fhir.dstu2.model.PrimitiveType
class PrimitiveType extends Type implements Serializable- serialVersionUID:
- 3L
-
Class org.hl7.fhir.dstu2.model.Procedure
class Procedure extends DomainResource implements Serializable- serialVersionUID:
- -489125036L
-
Serialized Fields
-
bodySite
List<CodeableConcept> bodySite
Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion. -
category
CodeableConcept category
A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure"). -
code
CodeableConcept code
The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy"). -
complication
List<CodeableConcept> complication
Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues. -
encounter
Reference encounter
The encounter during which the procedure was performed. -
encounterTarget
Encounter encounterTarget
The actual object that is the target of the reference (The encounter during which the procedure was performed.) -
focalDevice
List<Procedure.ProcedureFocalDeviceComponent> focalDevice
A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure. -
followUp
List<CodeableConcept> followUp
If the procedure required specific follow up - e.g. removal of sutures. The followup may be represented as a simple note, or could potentially be more complex in which case the CarePlan resource can be used. -
identifier
List<Identifier> identifier
This records identifiers associated with this procedure 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). -
location
Reference location
The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant. -
locationTarget
Location locationTarget
The actual object that is the target of the reference (The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.) -
notes
List<Annotation> notes
Any other notes about the procedure. E.g. the operative notes. -
notPerformed
BooleanType notPerformed
Set this to true if the record is saying that the procedure was NOT performed. -
outcome
CodeableConcept outcome
The outcome of the procedure - did it resolve reasons for the procedure being performed? -
performed
Type performed
The date(time)/period over which the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured. -
performer
List<Procedure.ProcedurePerformerComponent> performer
Limited to 'real' people rather than equipment. -
reason
Type reason
The reason why the procedure was performed. This may be due to a Condition, may be coded entity of some type, or may simply be present as text. -
reasonNotPerformed
List<CodeableConcept> reasonNotPerformed
A code indicating why the procedure was not performed. -
report
List<Reference> report
This could be a histology result, pathology report, surgical report, etc.. -
reportTarget
List<DiagnosticReport> reportTarget
The actual objects that are the target of the reference (This could be a histology result, pathology report, surgical report, etc..) -
request
Reference request
A reference to a resource that contains details of the request for this procedure. -
requestTarget
Resource requestTarget
The actual object that is the target of the reference (A reference to a resource that contains details of the request for this procedure.) -
status
Enumeration<Procedure.ProcedureStatus> status
A code specifying the state of the procedure. Generally this will be in-progress or completed state. -
subject
Reference subject
The person, animal or group on which the procedure was performed. -
subjectTarget
Resource subjectTarget
The actual object that is the target of the reference (The person, animal or group on which the procedure was performed.) -
used
List<Reference> used
Identifies medications, devices and any other substance used as part of the procedure. -
usedTarget
List<Resource> usedTarget
The actual objects that are the target of the reference (Identifies medications, devices and any other substance used as part of the procedure.)
-
-
Class org.hl7.fhir.dstu2.model.Procedure.ProcedureFocalDeviceComponent
class ProcedureFocalDeviceComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1779937807L
-
Serialized Fields
-
action
CodeableConcept action
The kind of change that happened to the device during the procedure. -
manipulated
Reference manipulated
The device that was manipulated (changed) during the procedure. -
manipulatedTarget
Device manipulatedTarget
The actual object that is the target of the reference (The device that was manipulated (changed) during the procedure.)
-
-
Class org.hl7.fhir.dstu2.model.Procedure.ProcedurePerformerComponent
class ProcedurePerformerComponent extends BackboneElement implements Serializable- serialVersionUID:
- -843698327L
-
Serialized Fields
-
actor
Reference actor
The practitioner who was involved in the procedure. -
actorTarget
Resource actorTarget
The actual object that is the target of the reference (The practitioner who was involved in the procedure.) -
role
CodeableConcept role
For example: surgeon, anaethetist, endoscopist.
-
-
Class org.hl7.fhir.dstu2.model.Procedure.ProcedureStatusEnumFactory
class ProcedureStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.ProcedureRequest
class ProcedureRequest extends DomainResource implements Serializable- serialVersionUID:
- -916650578L
-
Serialized Fields
-
asNeeded
Type asNeeded
If a CodeableConcept is present, it indicates the pre-condition for performing the procedure. -
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
The specific procedure that is ordered. Use text if the exact nature of the procedure cannot be coded. -
encounter
Reference encounter
The encounter within which the procedure proposal or request was created. -
encounterTarget
Encounter encounterTarget
The actual object that is the target of the reference (The encounter within which the procedure proposal or request was created.) -
identifier
List<Identifier> identifier
Identifiers assigned to this order by the order or by the receiver. -
notes
List<Annotation> notes
Any other notes associated with this proposal or order - e.g. provider instructions. -
orderedOn
DateTimeType orderedOn
The time when the request was made. -
orderer
Reference orderer
The healthcare professional responsible for proposing or ordering the procedure. -
ordererTarget
Resource ordererTarget
The actual object that is the target of the reference (The healthcare professional responsible for proposing or ordering the procedure.) -
performer
Reference performer
For example, the surgeon, anaethetist, endoscopist, etc. -
performerTarget
Resource performerTarget
The actual object that is the target of the reference (For example, the surgeon, anaethetist, endoscopist, etc.) -
priority
Enumeration<ProcedureRequest.ProcedureRequestPriority> priority
The clinical priority associated with this order. -
reason
Type reason
The reason why the procedure is being proposed or ordered. This procedure request may be motivated by a Condition for instance. -
scheduled
Type scheduled
The timing schedule for the proposed or ordered procedure. The Schedule data type allows many different expressions. E.g. "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". -
status
Enumeration<ProcedureRequest.ProcedureRequestStatus> status
The status of the order. -
subject
Reference subject
The person, animal or group that should receive the procedure. -
subjectTarget
Resource subjectTarget
The actual object that is the target of the reference (The person, animal or group that should receive the procedure.)
-
-
Class org.hl7.fhir.dstu2.model.ProcedureRequest.ProcedureRequestPriorityEnumFactory
class ProcedureRequestPriorityEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.ProcedureRequest.ProcedureRequestStatusEnumFactory
class ProcedureRequestStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.ProcessRequest
class ProcessRequest extends DomainResource implements Serializable- serialVersionUID:
- -1332331220L
-
Serialized Fields
-
action
Enumeration<ProcessRequest.ActionList> action
The type of processing action being requested, for example Reversal, Readjudication, StatusRequest,PendedRequest. -
created
DateTimeType created
The date when this resource was created. -
exclude
List<StringType> exclude
Names of resource types to exclude. -
identifier
List<Identifier> identifier
The ProcessRequest business identifier. -
include
List<StringType> include
Names of resource types to include. -
item
List<ProcessRequest.ItemsComponent> item
List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated. -
nullify
BooleanType nullify
If true remove all history excluding audit. -
organization
Reference organization
The organization which is responsible for the action speccified in thise request. -
organizationTarget
Organization organizationTarget
The actual object that is the target of the reference (The organization which is responsible for the action speccified in thise request.) -
originalRuleset
Coding originalRuleset
The style (standard) and version of the original material which was converted into this resource. -
period
Period period
A period of time during which the fulfilling resources would have been created. -
provider
Reference provider
The practitioner who is responsible for the action specified in thise request. -
providerTarget
Practitioner providerTarget
The actual object that is the target of the reference (The practitioner who is responsible for the action specified in thise request.) -
reference
StringType reference
A reference to supply which authenticates the process. -
request
Reference request
Reference of resource which is the target or subject of this action. -
requestTarget
Resource requestTarget
The actual object that is the target of the reference (Reference of resource which is the target or subject of this action.) -
response
Reference response
Reference of a prior response to resource which is the target or subject of this action. -
responseTarget
Resource responseTarget
The actual object that is the target of the reference (Reference of a prior response to resource which is the target or subject of this action.) -
ruleset
Coding ruleset
The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources. -
target
Reference target
The organization which is the target of the request. -
targetTarget
Organization targetTarget
The actual object that is the target of the reference (The organization which is the target of the request.)
-
-
Class org.hl7.fhir.dstu2.model.ProcessRequest.ActionListEnumFactory
class ActionListEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.ProcessRequest.ItemsComponent
class ItemsComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1598360600L
-
Serialized Fields
-
sequenceLinkId
IntegerType sequenceLinkId
A service line number.
-
-
Class org.hl7.fhir.dstu2.model.ProcessResponse
class ProcessResponse extends DomainResource implements Serializable- serialVersionUID:
- -1668062545L
-
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 or processing. -
error
List<Coding> error
Processing errors. -
form
Coding form
The form to be used for printing the content. -
identifier
List<Identifier> identifier
The Response business identifier. -
notes
List<ProcessResponse.ProcessResponseNotesComponent> notes
Suite of processing note or additional requirements is the processing has been held. -
organization
Reference organization
The organization who produced this adjudicated response. -
organizationTarget
Organization organizationTarget
The actual object that is the target of the reference (The organization who produced this adjudicated response.) -
originalRuleset
Coding originalRuleset
The style (standard) and version of the original material which was converted into this resource. -
outcome
Coding outcome
Transaction status: error, complete, held. -
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
Resource requestTarget
The actual object that is the target of the reference (Original request resource reference.) -
ruleset
Coding ruleset
The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.
-
-
Class org.hl7.fhir.dstu2.model.ProcessResponse.ProcessResponseNotesComponent
class ProcessResponseNotesComponent extends BackboneElement implements Serializable- serialVersionUID:
- 129959202L
-
Serialized Fields
-
text
StringType text
The note text. -
type
Coding type
The note purpose: Print/Display.
-
-
Class org.hl7.fhir.dstu2.model.Provenance
class Provenance extends DomainResource implements Serializable- serialVersionUID:
- -1053458671L
-
Serialized Fields
-
activity
CodeableConcept activity
An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities. -
agent
List<Provenance.ProvenanceAgentComponent> agent
An agent takes a role in an activity such that the agent can be assigned some degree of responsibility for the activity taking place. An agent can be a person, an organization, software, or other entities that may be ascribed responsibility. -
entity
List<Provenance.ProvenanceEntityComponent> entity
An entity used in this activity. -
location
Reference location
Where the activity occurred, if relevant. -
locationTarget
Location locationTarget
The actual object that is the target of the reference (Where the activity occurred, if relevant.) -
period
Period period
The period during which the activity occurred. -
policy
List<UriType> policy
Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc. -
reason
List<CodeableConcept> reason
The reason that the activity was taking place. -
recorded
InstantType recorded
The instant of time at which the activity was recorded. -
signature
List<Signature> signature
A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated. -
target
List<Reference> target
The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity. -
targetTarget
List<Resource> targetTarget
The actual objects that are the target of the reference (The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.)
-
-
Class org.hl7.fhir.dstu2.model.Provenance.ProvenanceAgentComponent
class ProvenanceAgentComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1792758952L
-
Serialized Fields
-
actor
Reference actor
The individual, device or organization that participated in the event. -
actorTarget
Resource actorTarget
The actual object that is the target of the reference (The individual, device or organization that participated in the event.) -
relatedAgent
List<Provenance.ProvenanceAgentRelatedAgentComponent> relatedAgent
A relationship between two the agents referenced in this resource. This is defined to allow for explicit description of the delegation between agents. For example, this human author used this device, or one person acted on another's behest. -
role
Coding role
The function of the agent with respect to the activity. -
userId
Identifier userId
The identity of the agent as known by the authorization system.
-
-
Class org.hl7.fhir.dstu2.model.Provenance.ProvenanceAgentRelatedAgentComponent
class ProvenanceAgentRelatedAgentComponent extends BackboneElement implements Serializable- serialVersionUID:
- 794181198L
-
Serialized Fields
-
target
UriType target
An internal reference to another agent listed in this provenance by its identifier. -
type
CodeableConcept type
The type of relationship between agents.
-
-
Class org.hl7.fhir.dstu2.model.Provenance.ProvenanceEntityComponent
class ProvenanceEntityComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1533729633L
-
Serialized Fields
-
agent
Provenance.ProvenanceAgentComponent agent
The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity. -
display
StringType display
Human-readable description of the entity. -
reference
UriType reference
Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative. -
role
Enumeration<Provenance.ProvenanceEntityRole> role
How the entity was used during the activity. -
type
Coding type
The type of the entity. If the entity is a resource, then this is a resource type.
-
-
Class org.hl7.fhir.dstu2.model.Provenance.ProvenanceEntityRoleEnumFactory
class ProvenanceEntityRoleEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Quantity
class Quantity extends Type implements Serializable- serialVersionUID:
- 1069574054L
-
Serialized Fields
-
code
CodeType code
A computer processable form of the unit in some unit representation system. -
comparator
Enumeration<Quantity.QuantityComparator> comparator
How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "invalid input: '<'" , then the real value is invalid input: '<' stated value. -
system
UriType system
The identification of the system that provides the coded form of the unit. -
unit
StringType unit
A human-readable form of the unit. -
value
DecimalType value
The value of the measured amount. The value includes an implicit precision in the presentation of the value.
-
-
Class org.hl7.fhir.dstu2.model.Quantity.QuantityComparatorEnumFactory
class QuantityComparatorEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Questionnaire
class Questionnaire extends DomainResource implements Serializable- serialVersionUID:
- -1348292652L
-
Serialized Fields
-
date
DateTimeType date
The date that this questionnaire was last changed. -
group
Questionnaire.GroupComponent group
A collection of related questions (or further groupings of questions). -
identifier
List<Identifier> identifier
This records identifiers associated with this question set 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). -
publisher
StringType publisher
Organization or person responsible for developing and maintaining the questionnaire. -
status
Enumeration<Questionnaire.QuestionnaireStatus> status
The lifecycle status of the questionnaire as a whole. -
subjectType
List<CodeType> subjectType
Identifies the types of subjects that can be the subject of the questionnaire. -
telecom
List<ContactPoint> telecom
Contact details to assist a user in finding and communicating with the publisher. -
version
StringType version
The version number assigned by the publisher for business reasons. It may remain the same when the resource is updated.
-
-
Class org.hl7.fhir.dstu2.model.Questionnaire.AnswerFormatEnumFactory
class AnswerFormatEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Questionnaire.GroupComponent
class GroupComponent extends BackboneElement implements Serializable- serialVersionUID:
- 494129548L
-
Serialized Fields
-
concept
List<Coding> concept
Identifies a how this group of questions is known in a particular terminology such as LOINC. -
group
List<Questionnaire.GroupComponent> group
A sub-group within a group. The ordering of groups within this group is relevant. -
linkId
StringType linkId
An identifier that is unique within the Questionnaire allowing linkage to the equivalent group in a QuestionnaireResponse resource. -
question
List<Questionnaire.QuestionComponent> question
Set of questions within this group. The order of questions within the group is relevant. -
repeats
BooleanType repeats
Whether the group may occur multiple times in the instance, containing multiple sets of answers. -
required
BooleanType required
If true, indicates that the group must be present and have required questions within it answered. If false, the group may be skipped when answering the questionnaire. -
text
StringType text
Additional text for the group, used for display purposes. -
title
StringType title
The human-readable name for this section of the questionnaire.
-
-
Class org.hl7.fhir.dstu2.model.Questionnaire.QuestionComponent
class QuestionComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1078951042L
-
Serialized Fields
-
concept
List<Coding> concept
Identifies a how this question is known in a particular terminology such as LOINC. -
group
List<Questionnaire.GroupComponent> group
Nested group, containing nested question for this question. The order of groups within the question is relevant. -
linkId
StringType linkId
An identifier that is unique within the questionnaire allowing linkage to the equivalent group in a [[[QuestionnaireResponse]]] resource. -
option
List<Coding> option
For a "choice" question, identifies one of the permitted answers for the question. -
options
Reference options
Reference to a value set containing a list of codes representing permitted answers for the question. -
optionsTarget
ValueSet optionsTarget
The actual object that is the target of the reference (Reference to a value set containing a list of codes representing permitted answers for the question.) -
repeats
BooleanType repeats
If true, the question may have more than one answer. -
required
BooleanType required
If true, indicates that the question must be answered and have required groups within it also present. If false, the question and any contained groups may be skipped when answering the questionnaire. -
text
StringType text
The actual question as shown to the user to prompt them for an answer. -
type
Enumeration<Questionnaire.AnswerFormat> type
The expected format of the answer, e.g. the type of input (string, integer) or whether a (multiple) choice is expected.
-
-
Class org.hl7.fhir.dstu2.model.Questionnaire.QuestionnaireStatusEnumFactory
class QuestionnaireStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.QuestionnaireResponse
class QuestionnaireResponse extends DomainResource implements Serializable- serialVersionUID:
- -1081988635L
-
Serialized Fields
-
author
Reference author
Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system. -
authored
DateTimeType authored
The date and/or time that this version of the questionnaire response was authored. -
authorTarget
Resource authorTarget
The actual object that is the target of the reference (Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.) -
encounter
Reference encounter
Encounter during which this set of questionnaire response were collected. When there were multiple encounters, this is the one considered most relevant to the context of the answers. -
encounterTarget
Encounter encounterTarget
The actual object that is the target of the reference (Encounter during which this set of questionnaire response were collected. When there were multiple encounters, this is the one considered most relevant to the context of the answers.) -
group
QuestionnaireResponse.GroupComponent group
A group of questions to a possibly similarly grouped set of questions in the questionnaire response. -
identifier
Identifier identifier
A business identifier assigned to a particular completed (or partially completed) questionnaire. -
questionnaire
Reference questionnaire
Indicates the Questionnaire resource that defines the form for which answers are being provided. -
questionnaireTarget
Questionnaire questionnaireTarget
The actual object that is the target of the reference (Indicates the Questionnaire resource that defines the form for which answers are being provided.) -
source
Reference source
The person who answered the questions about the subject. -
sourceTarget
Resource sourceTarget
The actual object that is the target of the reference (The person who answered the questions about the subject.) -
status
Enumeration<QuestionnaireResponse.QuestionnaireResponseStatus> status
The lifecycle status of the questionnaire response as a whole. -
subject
Reference subject
The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information. -
subjectTarget
Resource subjectTarget
The actual object that is the target of the reference (The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information.)
-
-
Class org.hl7.fhir.dstu2.model.QuestionnaireResponse.GroupComponent
class GroupComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1045990435L
-
Serialized Fields
-
group
List<QuestionnaireResponse.GroupComponent> group
A sub-group within a group. The ordering of groups within this group is relevant. -
linkId
StringType linkId
Identifies the group from the Questionnaire that corresponds to this group in the QuestionnaireResponse resource. -
question
List<QuestionnaireResponse.QuestionComponent> question
Set of questions within this group. The order of questions within the group is relevant. -
subject
Reference subject
More specific subject this section's answers are about, details the subject given in QuestionnaireResponse. -
subjectTarget
Resource subjectTarget
The actual object that is the target of the reference (More specific subject this section's answers are about, details the subject given in QuestionnaireResponse.) -
text
StringType text
Additional text for the group, used for display purposes. -
title
StringType title
Text that is displayed above the contents of the group.
-
-
Class org.hl7.fhir.dstu2.model.QuestionnaireResponse.QuestionAnswerComponent
class QuestionAnswerComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1223680118L
-
Serialized Fields
-
group
List<QuestionnaireResponse.GroupComponent> group
Nested group, containing nested question for this question. The order of groups within the question is relevant. -
value
Type value
The answer (or one of the answers) provided by the respondent to the question.
-
-
Class org.hl7.fhir.dstu2.model.QuestionnaireResponse.QuestionComponent
class QuestionComponent extends BackboneElement implements Serializable- serialVersionUID:
- -265263901L
-
Serialized Fields
-
answer
List<QuestionnaireResponse.QuestionAnswerComponent> answer
The respondent's answer(s) to the question. -
linkId
StringType linkId
Identifies the question from the Questionnaire that corresponds to this question in the QuestionnaireResponse resource. -
text
StringType text
The actual question as shown to the user to prompt them for an answer.
-
-
Class org.hl7.fhir.dstu2.model.QuestionnaireResponse.QuestionnaireResponseStatusEnumFactory
class QuestionnaireResponseStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Range
class Range extends Type implements Serializable- serialVersionUID:
- 1699187994L
-
Serialized Fields
-
high
SimpleQuantity high
The high limit. The boundary is inclusive. -
low
SimpleQuantity low
The low limit. The boundary is inclusive.
-
-
Class org.hl7.fhir.dstu2.model.Ratio
class Ratio extends Type implements Serializable- serialVersionUID:
- 479922563L
-
Class org.hl7.fhir.dstu2.model.Reference
class Reference extends BaseReference implements Serializable- serialVersionUID:
- 22777321L
-
Serialized Fields
-
display
StringType display
Plain text narrative that identifies the resource in addition to the resource reference. -
reference
StringType reference
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
-
-
Class org.hl7.fhir.dstu2.model.ReferralRequest
class ReferralRequest extends DomainResource implements Serializable- serialVersionUID:
- 1948652599L
-
Serialized Fields
-
date
DateTimeType date
Date/DateTime of creation for draft requests and date of activation for active requests. -
dateSent
DateTimeType dateSent
Date/DateTime the request for referral or transfer of care is sent by the author. -
description
StringType description
The reason element gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary. -
encounter
Reference encounter
The encounter at which the request for referral or transfer of care is initiated. -
encounterTarget
Encounter encounterTarget
The actual object that is the target of the reference (The encounter at which the request for referral or transfer of care is initiated.) -
fulfillmentTime
Period fulfillmentTime
The period of time within which the services identified in the referral/transfer of care is specified or required to occur. -
identifier
List<Identifier> identifier
Business identifier that uniquely identifies the referral/care transfer request instance. -
patient
Reference patient
The patient who is the subject of a referral or transfer of care request. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (The patient who is the subject of a referral or transfer of care request.) -
priority
CodeableConcept priority
An indication of the urgency of referral (or where applicable the type of transfer of care) request. -
reason
CodeableConcept reason
Description of clinical condition indicating why referral/transfer of care is requested. For example: Pathological Anomalies, Disabled (physical or mental), Behavioral Management. -
recipient
List<Reference> recipient
The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request. -
recipientTarget
List<Resource> recipientTarget
The actual objects that are the target of the reference (The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.) -
requester
Reference requester
The healthcare provider or provider organization who/which initiated the referral/transfer of care request. Can also be Patient (a self referral). -
requesterTarget
Resource requesterTarget
The actual object that is the target of the reference (The healthcare provider or provider organization who/which initiated the referral/transfer of care request. Can also be Patient (a self referral).) -
serviceRequested
List<CodeableConcept> serviceRequested
The service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion. -
specialty
CodeableConcept specialty
Indication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology. -
status
Enumeration<ReferralRequest.ReferralStatus> status
The workflow status of the referral or transfer of care request. -
supportingInformation
List<Reference> supportingInformation
Any additional (administrative, financial or clinical) information required to support request for referral or transfer of care. For example: Presenting problems/chief complaints Medical History Family History Alerts Allergy/Intolerance and Adverse Reactions Medications Observations/Assessments (may include cognitive and fundtional assessments) Diagnostic Reports Care Plan. -
supportingInformationTarget
List<Resource> supportingInformationTarget
The actual objects that are the target of the reference (Any additional (administrative, financial or clinical) information required to support request for referral or transfer of care. For example: Presenting problems/chief complaints Medical History Family History Alerts Allergy/Intolerance and Adverse Reactions Medications Observations/Assessments (may include cognitive and fundtional assessments) Diagnostic Reports Care Plan.) -
type
CodeableConcept type
An indication of the type of referral (or where applicable the type of transfer of care) request.
-
-
Class org.hl7.fhir.dstu2.model.ReferralRequest.ReferralStatusEnumFactory
class ReferralStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.RelatedPerson
class RelatedPerson extends DomainResource implements Serializable- serialVersionUID:
- 7777543L
-
Serialized Fields
-
address
List<Address> address
Address where the related person can be contacted or visited. -
birthDate
DateType birthDate
The date on which the related person was born. -
gender
Enumeration<Enumerations.AdministrativeGender> gender
Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. -
identifier
List<Identifier> identifier
Identifier for a person within a particular scope. -
name
HumanName name
A name associated with the person. -
patient
Reference patient
The patient this person is related to. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (The patient this person is related to.) -
period
Period period
The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown. -
photo
List<Attachment> photo
Image of the person. -
relationship
CodeableConcept relationship
The nature of the relationship between a patient and the related person. -
telecom
List<ContactPoint> telecom
A contact detail for the person, e.g. a telephone number or an email address.
-
-
Class org.hl7.fhir.dstu2.model.Resource
class Resource extends BaseResource implements Serializable- serialVersionUID:
- -559462759L
-
Serialized Fields
-
id
IdType id
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. -
implicitRules
UriType implicitRules
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. -
language
CodeType language
The base language in which the resource is written. -
meta
Meta meta
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
-
-
Class org.hl7.fhir.dstu2.model.RiskAssessment
class RiskAssessment extends DomainResource implements Serializable- serialVersionUID:
- 724306293L
-
Serialized Fields
-
basis
List<Reference> basis
Indicates the source data considered as part of the assessment (FamilyHistory, Observations, Procedures, Conditions, etc.). -
basisTarget
List<Resource> basisTarget
The actual objects that are the target of the reference (Indicates the source data considered as part of the assessment (FamilyHistory, Observations, Procedures, Conditions, etc.).) -
condition
Reference condition
For assessments or prognosis specific to a particular condition, indicates the condition being assessed. -
conditionTarget
Condition conditionTarget
The actual object that is the target of the reference (For assessments or prognosis specific to a particular condition, indicates the condition being assessed.) -
date
DateTimeType date
The date (and possibly time) the risk assessment was performed. -
encounter
Reference encounter
The encounter where the assessment was performed. -
encounterTarget
Encounter encounterTarget
The actual object that is the target of the reference (The encounter where the assessment was performed.) -
identifier
Identifier identifier
Business identifier assigned to the risk assessment. -
method
CodeableConcept method
The algorithm, process or mechanism used to evaluate the risk. -
mitigation
StringType mitigation
A description of the steps that might be taken to reduce the identified risk(s). -
performer
Reference performer
The provider or software application that performed the assessment. -
performerTarget
Resource performerTarget
The actual object that is the target of the reference (The provider or software application that performed the assessment.) -
prediction
List<RiskAssessment.RiskAssessmentPredictionComponent> prediction
Describes the expected outcome for the subject. -
subject
Reference subject
The patient or group the risk assessment applies to. -
subjectTarget
Resource subjectTarget
The actual object that is the target of the reference (The patient or group the risk assessment applies to.)
-
-
Class org.hl7.fhir.dstu2.model.RiskAssessment.RiskAssessmentPredictionComponent
class RiskAssessmentPredictionComponent extends BackboneElement implements Serializable- serialVersionUID:
- 647967428L
-
Serialized Fields
-
outcome
CodeableConcept outcome
One of the potential outcomes for the patient (e.g. remission, death, a particular condition). -
probability
Type probability
How likely is the outcome (in the specified timeframe). -
rationale
StringType rationale
Additional information explaining the basis for the prediction. -
relativeRisk
DecimalType relativeRisk
Indicates the risk for this particular subject (with their specific characteristics) divided by the risk of the population in general. (Numbers greater than 1 = higher risk than the population, numbers less than 1 = lower risk.). -
when
Type when
Indicates the period of time or age range of the subject to which the specified probability applies.
-
-
Class org.hl7.fhir.dstu2.model.SampledData
class SampledData extends Type implements Serializable- serialVersionUID:
- -1763278368L
-
Serialized Fields
-
data
StringType data
A series of data points which are decimal values separated by a single space (character u20). The special values "E" (error), "L" (below detection limit) and "U" (above detection limit) can also be used in place of a decimal value. -
dimensions
PositiveIntType dimensions
The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once. -
factor
DecimalType factor
A correction factor that is applied to the sampled data points before they are added to the origin. -
lowerLimit
DecimalType lowerLimit
The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit). -
origin
SimpleQuantity origin
The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series. -
period
DecimalType period
The length of time between sampling times, measured in milliseconds. -
upperLimit
DecimalType upperLimit
The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).
-
-
Class org.hl7.fhir.dstu2.model.Schedule
class Schedule extends DomainResource implements Serializable- serialVersionUID:
- 158030926L
-
Serialized Fields
-
actor
Reference actor
The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, Device, Patient or RelatedPerson. -
actorTarget
Resource actorTarget
The actual object that is the target of the reference (The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, Device, Patient or RelatedPerson.) -
comment
StringType comment
Comments on the availability to describe any extended information. Such as custom constraints on the slot(s) that may be associated. -
identifier
List<Identifier> identifier
External Ids for this item. -
planningHorizon
Period planningHorizon
The period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates. -
type
List<CodeableConcept> type
The schedule type can be used for the categorization of healthcare services or other appointment types.
-
-
Class org.hl7.fhir.dstu2.model.SearchParameter
class SearchParameter extends DomainResource implements Serializable- serialVersionUID:
- -742596414L
-
Serialized Fields
-
base
CodeType base
The base resource type that this search parameter refers to. -
code
CodeType code
The code used in the URL or the parameter name in a parameters resource for this search parameter. -
contact
List<SearchParameter.SearchParameterContactComponent> contact
Contacts to assist a user in finding and communicating with the publisher. -
date
DateTimeType date
The date (and optionally time) when the search parameter definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes. -
description
StringType description
A description of the search parameters and how it used. -
experimental
BooleanType experimental
A flag to indicate that this search parameter definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. -
name
StringType name
A free text natural language name identifying the search parameter. -
publisher
StringType publisher
The name of the individual or organization that published the search parameter. -
requirements
StringType requirements
The Scope and Usage that this search parameter was created to meet. -
status
Enumeration<Enumerations.ConformanceResourceStatus> status
The status of this search parameter definition. -
target
List<CodeType> target
Types of resource (if a resource is referenced). -
type
Enumeration<Enumerations.SearchParamType> type
The type of value a search parameter refers to, and how the content is interpreted. -
url
UriType url
An absolute URL that is used to identify this search parameter when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published. -
xpath
StringType xpath
An XPath expression that returns a set of elements for the search parameter. -
xpathUsage
Enumeration<SearchParameter.XPathUsageType> xpathUsage
How the search parameter relates to the set of elements returned by evaluating the xpath query.
-
-
Class org.hl7.fhir.dstu2.model.SearchParameter.SearchParameterContactComponent
class SearchParameterContactComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1179697803L
-
Serialized Fields
-
name
StringType name
The name of an individual to contact regarding the search parameter. -
telecom
List<ContactPoint> telecom
Contact details for individual (if a name was provided) or the publisher.
-
-
Class org.hl7.fhir.dstu2.model.SearchParameter.XPathUsageTypeEnumFactory
class XPathUsageTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.SidType
class SidType extends UriType implements Serializable- serialVersionUID:
- 5486832330986493589L
-
Class org.hl7.fhir.dstu2.model.Signature
class Signature extends Type implements Serializable- serialVersionUID:
- -452432714L
-
Serialized Fields
-
blob
Base64BinaryType blob
The base64 encoding of the Signature content. -
contentType
CodeType contentType
A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jwt for JWT, and image/* for a graphical image of a signature. -
type
List<Coding> type
An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document. -
when
InstantType when
When the digital signature was signed. -
who
Type who
A reference to an application-usable description of the person that signed the certificate (e.g. the signature used their private key).
-
-
Class org.hl7.fhir.dstu2.model.SimpleQuantity
class SimpleQuantity extends Quantity implements Serializable- serialVersionUID:
- 1069574054L
-
Class org.hl7.fhir.dstu2.model.Slot
class Slot extends DomainResource implements Serializable- serialVersionUID:
- 1984269299L
-
Serialized Fields
-
comment
StringType comment
Comments on the slot to describe any extended information. Such as custom constraints on the slot. -
end
InstantType end
Date/Time that the slot is to conclude. -
freeBusyType
Enumeration<Slot.SlotStatus> freeBusyType
busy | free | busy-unavailable | busy-tentative. -
identifier
List<Identifier> identifier
External Ids for this item. -
overbooked
BooleanType overbooked
This slot has already been overbooked, appointments are unlikely to be accepted for this time. -
schedule
Reference schedule
The schedule resource that this slot defines an interval of status information. -
scheduleTarget
Schedule scheduleTarget
The actual object that is the target of the reference (The schedule resource that this slot defines an interval of status information.) -
start
InstantType start
Date/Time that the slot is to begin. -
type
CodeableConcept type
The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource.
-
-
Class org.hl7.fhir.dstu2.model.Slot.SlotStatusEnumFactory
class SlotStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Specimen
class Specimen extends DomainResource implements Serializable- serialVersionUID:
- 1025605602L
-
Serialized Fields
-
accessionIdentifier
Identifier accessionIdentifier
The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures. -
collection
Specimen.SpecimenCollectionComponent collection
Details concerning the specimen collection. -
container
List<Specimen.SpecimenContainerComponent> container
The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here. -
identifier
List<Identifier> identifier
Id for specimen. -
parent
List<Reference> parent
Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen. -
parentTarget
List<Specimen> parentTarget
The actual objects that are the target of the reference (Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.) -
receivedTime
DateTimeType receivedTime
Time when specimen was received for processing or testing. -
status
Enumeration<Specimen.SpecimenStatus> status
The availability of the specimen. -
subject
Reference subject
Where the specimen came from. This may be from the patient(s) or from the environment or a device. -
subjectTarget
Resource subjectTarget
The actual object that is the target of the reference (Where the specimen came from. This may be from the patient(s) or from the environment or a device.) -
treatment
List<Specimen.SpecimenTreatmentComponent> treatment
Details concerning treatment and processing steps for the specimen. -
type
CodeableConcept type
The kind of material that forms the specimen.
-
-
Class org.hl7.fhir.dstu2.model.Specimen.SpecimenCollectionComponent
class SpecimenCollectionComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1418734687L
-
Serialized Fields
-
bodySite
CodeableConcept bodySite
Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens. -
collected
Type collected
Time when specimen was collected from subject - the physiologically relevant time. -
collector
Reference collector
Person who collected the specimen. -
collectorTarget
Practitioner collectorTarget
The actual object that is the target of the reference (Person who collected the specimen.) -
comment
List<StringType> comment
To communicate any details or issues encountered during the specimen collection procedure. -
method
CodeableConcept method
A coded value specifying the technique that is used to perform the procedure. -
quantity
SimpleQuantity quantity
The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.
-
-
Class org.hl7.fhir.dstu2.model.Specimen.SpecimenContainerComponent
class SpecimenContainerComponent extends BackboneElement implements Serializable- serialVersionUID:
- 187274879L
-
Serialized Fields
-
additive
Type additive
Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA. -
capacity
SimpleQuantity capacity
The capacity (volume or other measure) the container may contain. -
description
StringType description
Textual description of the container. -
identifier
List<Identifier> identifier
Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances. -
specimenQuantity
SimpleQuantity specimenQuantity
The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type. -
type
CodeableConcept type
The type of container associated with the specimen (e.g. slide, aliquot, etc.).
-
-
Class org.hl7.fhir.dstu2.model.Specimen.SpecimenStatusEnumFactory
class SpecimenStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Specimen.SpecimenTreatmentComponent
class SpecimenTreatmentComponent extends BackboneElement implements Serializable- serialVersionUID:
- -373251521L
-
Serialized Fields
-
additive
List<Reference> additive
Material used in the processing step. -
additiveTarget
List<Substance> additiveTarget
The actual objects that are the target of the reference (Material used in the processing step.) -
description
StringType description
Textual description of procedure. -
procedure
CodeableConcept procedure
A coded value specifying the procedure used to process the specimen.
-
-
Class org.hl7.fhir.dstu2.model.StringType
- serialVersionUID:
- 3L
-
Class org.hl7.fhir.dstu2.model.StructureDefinition
class StructureDefinition extends DomainResource implements Serializable- serialVersionUID:
- -580779569L
-
Serialized Fields
-
abstract_
BooleanType abstract_
Whether structure this definition describes is abstract or not - that is, whether an actual exchanged item can ever be of this type. -
base
UriType base
An absolute URI that is the base structure from which this set of constraints is derived. -
code
List<Coding> code
A set of terms from external terminologies that may be used to assist with indexing and searching of templates. -
constrainedType
CodeType constrainedType
The type of type that is being constrained - a data type, an extension, a resource, including abstract ones. If this field is present, it indicates that the structure definition is a constraint. If it is not present, then the structure definition is the definition of a base structure. -
contact
List<StructureDefinition.StructureDefinitionContactComponent> contact
Contacts to assist a user in finding and communicating with the publisher. -
context
List<StringType> context
Identifies the types of resource or data type elements to which the extension can be applied. -
contextType
Enumeration<StructureDefinition.ExtensionContext> contextType
If this is an extension, Identifies the context within FHIR resources where the extension can be used. -
copyright
StringType copyright
A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings. -
date
DateTimeType date
The date this version of the structure definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the structure definition changes. -
description
StringType description
A free text natural language description of the StructureDefinition and its use. -
differential
StructureDefinition.StructureDefinitionDifferentialComponent differential
A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies. -
display
StringType display
Defined so that applications can use this name when displaying the value of the extension to the user. -
experimental
BooleanType experimental
This StructureDefinition was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. -
fhirVersion
IdType fhirVersion
The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 1.0.2 for this version. -
identifier
List<Identifier> identifier
Formal identifier that is used to identify this StructureDefinition when it is represented in other formats, or referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI), (if it's not possible to use the literal URI). -
kind
Enumeration<StructureDefinition.StructureDefinitionKind> kind
Defines the kind of structure that this definition is describing. -
mapping
List<StructureDefinition.StructureDefinitionMappingComponent> mapping
An external specification that the content is mapped to. -
name
StringType name
A free text natural language name identifying the StructureDefinition. -
publisher
StringType publisher
The name of the individual or organization that published the structure definition. -
requirements
StringType requirements
Explains why this structure definition is needed and why it's been constrained as it has. -
snapshot
StructureDefinition.StructureDefinitionSnapshotComponent snapshot
A snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base StructureDefinition. -
status
Enumeration<Enumerations.ConformanceResourceStatus> status
The status of the StructureDefinition. -
url
UriType url
An absolute URL that is used to identify this structure definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this structure definition is (or will be) published. -
useContext
List<CodeableConcept> useContext
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of structure definitions. -
version
StringType version
The identifier that is used to identify this version of the StructureDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the StructureDefinition author manually.
-
-
Class org.hl7.fhir.dstu2.model.StructureDefinition.ExtensionContextEnumFactory
class ExtensionContextEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.StructureDefinition.StructureDefinitionContactComponent
class StructureDefinitionContactComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1179697803L
-
Serialized Fields
-
name
StringType name
The name of an individual to contact regarding the structure definition. -
telecom
List<ContactPoint> telecom
Contact details for individual (if a name was provided) or the publisher.
-
-
Class org.hl7.fhir.dstu2.model.StructureDefinition.StructureDefinitionDifferentialComponent
class StructureDefinitionDifferentialComponent extends BackboneElement implements Serializable- serialVersionUID:
- 53896641L
-
Serialized Fields
-
element
List<ElementDefinition> element
Captures constraints on each element within the resource.
-
-
Class org.hl7.fhir.dstu2.model.StructureDefinition.StructureDefinitionKindEnumFactory
class StructureDefinitionKindEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.StructureDefinition.StructureDefinitionMappingComponent
class StructureDefinitionMappingComponent extends BackboneElement implements Serializable- serialVersionUID:
- 299630820L
-
Serialized Fields
-
comments
StringType comments
Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage. -
identity
IdType identity
An Internal id that is used to identify this mapping set when specific mappings are made. -
name
StringType name
A name for the specification that is being mapped to. -
uri
UriType uri
An absolute URI that identifies the specification that this mapping is expressed to.
-
-
Class org.hl7.fhir.dstu2.model.StructureDefinition.StructureDefinitionSnapshotComponent
class StructureDefinitionSnapshotComponent extends BackboneElement implements Serializable- serialVersionUID:
- 53896641L
-
Serialized Fields
-
element
List<ElementDefinition> element
Captures constraints on each element within the resource.
-
-
Class org.hl7.fhir.dstu2.model.Subscription
class Subscription extends DomainResource implements Serializable- serialVersionUID:
- -1390870804L
-
Serialized Fields
-
channel
Subscription.SubscriptionChannelComponent channel
Details where to send notifications when resources are received that meet the criteria. -
contact
List<ContactPoint> contact
Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting. -
criteria
StringType criteria
The rules that the server should use to determine when to generate notifications for this subscription. -
end
InstantType end
The time for the server to turn the subscription off. -
error
StringType error
A record of the last error that occurred when the server processed a notification. -
reason
StringType reason
A description of why this subscription is defined. -
status
Enumeration<Subscription.SubscriptionStatus> status
The status of the subscription, which marks the server state for managing the subscription. -
tag
List<Coding> tag
A tag to add to any resource that matches the criteria, after the subscription is processed.
-
-
Class org.hl7.fhir.dstu2.model.Subscription.SubscriptionChannelComponent
class SubscriptionChannelComponent extends BackboneElement implements Serializable- serialVersionUID:
- -279715391L
-
Serialized Fields
-
endpoint
UriType endpoint
The uri that describes the actual end-point to send messages to. -
header
StringType header
Additional headers / information to send as part of the notification. -
payload
StringType payload
The mime type to send the payload in - either application/xml+fhir, or application/json+fhir. If the mime type is blank, then there is no payload in the notification, just a notification. -
type
Enumeration<Subscription.SubscriptionChannelType> type
The type of channel to send notifications on.
-
-
Class org.hl7.fhir.dstu2.model.Subscription.SubscriptionChannelTypeEnumFactory
class SubscriptionChannelTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Subscription.SubscriptionStatusEnumFactory
class SubscriptionStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Substance
class Substance extends DomainResource implements Serializable- serialVersionUID:
- -1653977206L
-
Serialized Fields
-
category
List<CodeableConcept> category
A code that classifies the general type of substance. This is used for searching, sorting and display purposes. -
code
CodeableConcept code
A code (or set of codes) that identify this substance. -
description
StringType description
A description of the substance - its appearance, handling requirements, and other usage notes. -
identifier
List<Identifier> identifier
Unique identifier for the substance. -
ingredient
List<Substance.SubstanceIngredientComponent> ingredient
A substance can be composed of other substances. -
instance
List<Substance.SubstanceInstanceComponent> instance
Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.
-
-
Class org.hl7.fhir.dstu2.model.Substance.SubstanceIngredientComponent
class SubstanceIngredientComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1783242034L
-
Serialized Fields
-
quantity
Ratio quantity
The amount of the ingredient in the substance - a concentration ratio. -
substance
Reference substance
Another substance that is a component of this substance. -
substanceTarget
Substance substanceTarget
The actual object that is the target of the reference (Another substance that is a component of this substance.)
-
-
Class org.hl7.fhir.dstu2.model.Substance.SubstanceInstanceComponent
class SubstanceInstanceComponent extends BackboneElement implements Serializable- serialVersionUID:
- -794314734L
-
Serialized Fields
-
expiry
DateTimeType expiry
When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry. -
identifier
Identifier identifier
Identifier associated with the package/container (usually a label affixed directly). -
quantity
SimpleQuantity quantity
The amount of the substance.
-
-
Class org.hl7.fhir.dstu2.model.SupplyDelivery
class SupplyDelivery extends DomainResource implements Serializable- serialVersionUID:
- -1520129707L
-
Serialized Fields
-
destination
Reference destination
Identification of the facility/location where the Supply was shipped to, as part of the dispense event. -
destinationTarget
Location destinationTarget
The actual object that is the target of the reference (Identification of the facility/location where the Supply was shipped to, as part of the dispense event.) -
identifier
Identifier identifier
Identifier assigned by the dispensing facility when the item(s) is dispensed. -
patient
Reference patient
A link to a resource representing the person whom the delivered item is for. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (A link to a resource representing the person whom the delivered item is for.) -
quantity
SimpleQuantity quantity
The amount of supply that has been dispensed. Includes unit of measure. -
receiver
List<Reference> receiver
Identifies the person who picked up the Supply. -
receiverTarget
List<Practitioner> receiverTarget
The actual objects that are the target of the reference (Identifies the person who picked up the Supply.) -
status
Enumeration<SupplyDelivery.SupplyDeliveryStatus> status
A code specifying the state of the dispense event. -
suppliedItem
Reference suppliedItem
Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a simple attribute carrying a code that identifies the item from a known list. -
suppliedItemTarget
Resource suppliedItemTarget
The actual object that is the target of the reference (Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a simple attribute carrying a code that identifies the item from a known list.) -
supplier
Reference supplier
The individual responsible for dispensing the medication, supplier or device. -
supplierTarget
Practitioner supplierTarget
The actual object that is the target of the reference (The individual responsible for dispensing the medication, supplier or device.) -
time
DateTimeType time
The time the dispensed item was sent or handed to the patient (or agent). -
type
CodeableConcept type
Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. -
whenPrepared
Period whenPrepared
The time the dispense event occurred.
-
-
Class org.hl7.fhir.dstu2.model.SupplyDelivery.SupplyDeliveryStatusEnumFactory
class SupplyDeliveryStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.SupplyRequest
class SupplyRequest extends DomainResource implements Serializable- serialVersionUID:
- 1649766198L
-
Serialized Fields
-
date
DateTimeType date
When the request was made. -
identifier
Identifier identifier
Unique identifier for this supply request. -
kind
CodeableConcept kind
Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process. -
orderedItem
Reference orderedItem
The item that is requested to be supplied. -
orderedItemTarget
Resource orderedItemTarget
The actual object that is the target of the reference (The item that is requested to be supplied.) -
patient
Reference patient
A link to a resource representing the person whom the ordered item is for. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (A link to a resource representing the person whom the ordered item is for.) -
reason
Type reason
Why the supply item was requested. -
source
Reference source
The Practitioner , Organization or Patient who initiated this order for the supply. -
sourceTarget
Resource sourceTarget
The actual object that is the target of the reference (The Practitioner , Organization or Patient who initiated this order for the supply.) -
status
Enumeration<SupplyRequest.SupplyRequestStatus> status
Status of the supply request. -
supplier
List<Reference> supplier
Who is intended to fulfill the request. -
supplierTarget
List<Organization> supplierTarget
The actual objects that are the target of the reference (Who is intended to fulfill the request.) -
when
SupplyRequest.SupplyRequestWhenComponent when
When the request should be fulfilled.
-
-
Class org.hl7.fhir.dstu2.model.SupplyRequest.SupplyRequestStatusEnumFactory
class SupplyRequestStatusEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.SupplyRequest.SupplyRequestWhenComponent
class SupplyRequestWhenComponent extends BackboneElement implements Serializable- serialVersionUID:
- 307115287L
-
Serialized Fields
-
code
CodeableConcept code
Code indicating when the request should be fulfilled. -
schedule
Timing schedule
Formal fulfillment schedule.
-
-
Class org.hl7.fhir.dstu2.model.TestScript
class TestScript extends DomainResource implements Serializable- serialVersionUID:
- -2049162917L
-
Serialized Fields
-
contact
List<TestScript.TestScriptContactComponent> contact
Contacts to assist a user in finding and communicating with the publisher. -
copyright
StringType copyright
A copyright statement relating to the Test Script and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings. -
date
DateTimeType date
The date this version of the test tcript was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the test cases change. -
description
StringType description
A free text natural language description of the TestScript and its use. -
experimental
BooleanType experimental
This TestScript was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. -
fixture
List<TestScript.TestScriptFixtureComponent> fixture
Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute. -
identifier
Identifier identifier
Identifier for the TestScript assigned for external purposes outside the context of FHIR. -
metadata
TestScript.TestScriptMetadataComponent metadata
The required capability must exist and are assumed to function correctly on the FHIR server being tested. -
multiserver
BooleanType multiserver
If the tests apply to more than one FHIR server (e.g. cross-server interoperability tests) then multiserver=true. Defaults to false if value is unspecified. -
name
StringType name
A free text natural language name identifying the TestScript. -
profile
List<Reference> profile
Reference to the profile to be used for validation. -
profileTarget
List<Resource> profileTarget
The actual objects that are the target of the reference (Reference to the profile to be used for validation.) -
publisher
StringType publisher
The name of the individual or organization that published the Test Script. -
requirements
StringType requirements
Explains why this Test Script is needed and why it's been constrained as it has. -
setup
TestScript.TestScriptSetupComponent setup
A series of required setup operations before tests are executed. -
status
Enumeration<Enumerations.ConformanceResourceStatus> status
The status of the TestScript. -
teardown
TestScript.TestScriptTeardownComponent teardown
A series of operations required to clean up after the all the tests are executed (successfully or otherwise). -
test
List<TestScript.TestScriptTestComponent> test
A test in this script. -
url
UriType url
An absolute URL that is used to identify this Test Script. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this Test Script is (or will be) published. -
useContext
List<CodeableConcept> useContext
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of Test Scripts. -
variable
List<TestScript.TestScriptVariableComponent> variable
Variable is set based either on element value in response body or on header field value in the response headers. -
version
StringType version
The identifier that is used to identify this version of the TestScript. This is an arbitrary value managed by the TestScript author manually.
-
-
Class org.hl7.fhir.dstu2.model.TestScript.AssertionDirectionTypeEnumFactory
class AssertionDirectionTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.TestScript.AssertionOperatorTypeEnumFactory
class AssertionOperatorTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.TestScript.AssertionResponseTypesEnumFactory
class AssertionResponseTypesEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.TestScript.ContentTypeEnumFactory
class ContentTypeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.TestScript.TestScriptContactComponent
class TestScriptContactComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1179697803L
-
Serialized Fields
-
name
StringType name
The name of an individual to contact regarding the Test Script. -
telecom
List<ContactPoint> telecom
Contact details for individual (if a name was provided) or the publisher.
-
-
Class org.hl7.fhir.dstu2.model.TestScript.TestScriptFixtureComponent
class TestScriptFixtureComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1110683307L
-
Serialized Fields
-
autocreate
BooleanType autocreate
Whether or not to implicitly create the fixture during setup. If true, the fixture is automatically created on each server being tested during setup, therefore no create operation is required for this fixture in the TestScript.setup section. -
autodelete
BooleanType autodelete
Whether or not to implicitly delete the fixture during teardown If true, the fixture is automatically deleted on each server being tested during teardown, therefore no delete operation is required for this fixture in the TestScript.teardown section. -
resource
Reference resource
Reference to the resource (containing the contents of the resource needed for operations). -
resourceTarget
Resource resourceTarget
The actual object that is the target of the reference (Reference to the resource (containing the contents of the resource needed for operations).)
-
-
Class org.hl7.fhir.dstu2.model.TestScript.TestScriptMetadataCapabilityComponent
class TestScriptMetadataCapabilityComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1318523355L
-
Serialized Fields
-
conformance
Reference conformance
Minimum conformance required of server for test script to execute successfully. If server does not meet at a minimum the reference conformance definition, then all tests in this script are skipped. -
conformanceTarget
Conformance conformanceTarget
The actual object that is the target of the reference (Minimum conformance required of server for test script to execute successfully. If server does not meet at a minimum the reference conformance definition, then all tests in this script are skipped.) -
description
StringType description
Description of the capabilities that this test script is requiring the server to support. -
destination
IntegerType destination
Which server these requirements apply to. -
link
List<UriType> link
Links to the FHIR specification that describes this interaction and the resources involved in more detail. -
required
BooleanType required
Whether or not the test execution will require the given capabilities of the server in order for this test script to execute. -
validated
BooleanType validated
Whether or not the test execution will validate the given capabilities of the server in order for this test script to execute.
-
-
Class org.hl7.fhir.dstu2.model.TestScript.TestScriptMetadataComponent
class TestScriptMetadataComponent extends BackboneElement implements Serializable- serialVersionUID:
- 745183328L
-
Serialized Fields
-
capability
List<TestScript.TestScriptMetadataCapabilityComponent> capability
Capabilities that must exist and are assumed to function correctly on the FHIR server being tested. -
link
List<TestScript.TestScriptMetadataLinkComponent> link
A link to the FHIR specification that this test is covering.
-
-
Class org.hl7.fhir.dstu2.model.TestScript.TestScriptMetadataLinkComponent
class TestScriptMetadataLinkComponent extends BackboneElement implements Serializable- serialVersionUID:
- 213372298L
-
Serialized Fields
-
description
StringType description
Short description of the link. -
url
UriType url
URL to a particular requirement or feature within the FHIR specification.
-
-
Class org.hl7.fhir.dstu2.model.TestScript.TestScriptSetupActionAssertComponent
class TestScriptSetupActionAssertComponent extends BackboneElement implements Serializable- serialVersionUID:
- -607939856L
-
Serialized Fields
-
compareToSourceId
StringType compareToSourceId
Id of fixture used to compare the "sourceId/path" evaluations to. -
compareToSourcePath
StringType compareToSourcePath
XPath or JSONPath expression against fixture used to compare the "sourceId/path" evaluations to. -
contentType
Enumeration<TestScript.ContentType> contentType
The content-type or mime-type to use for RESTful operation in the 'Content-Type' header. -
description
StringType description
The description would be used by test engines for tracking and reporting purposes. -
direction
Enumeration<TestScript.AssertionDirectionType> direction
The direction to use for the assertion. -
headerField
StringType headerField
The HTTP header field name e.g. 'Location'. -
label
StringType label
The label would be used for tracking/logging purposes by test engines. -
minimumId
StringType minimumId
The ID of a fixture. Asserts that the response contains at a minimumId the fixture specified by minimumId. -
navigationLinks
BooleanType navigationLinks
Whether or not the test execution performs validation on the bundle navigation links. -
operator
Enumeration<TestScript.AssertionOperatorType> operator
The operator type. -
path
StringType path
The XPath or JSONPath expression to be evaluated against the fixture representing the response received from server. -
resource
CodeType resource
The type of the resource. See http://hl7-fhir.github.io/resourcelist.html. -
response
Enumeration<TestScript.AssertionResponseTypes> response
okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable. -
responseCode
StringType responseCode
The value of the HTTP response code to be tested. -
sourceId
IdType sourceId
Fixture to evaluate the XPath/JSONPath expression or the headerField against. -
validateProfileId
IdType validateProfileId
The ID of the Profile to validate against. -
value
StringType value
The value to compare to. -
warningOnly
BooleanType warningOnly
Whether or not the test execution will produce a warning only on error for this assert.
-
-
Class org.hl7.fhir.dstu2.model.TestScript.TestScriptSetupActionComponent
class TestScriptSetupActionComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1411550037L
-
Serialized Fields
-
assert_
TestScript.TestScriptSetupActionAssertComponent assert_
Evaluates the results of previous operations to determine if the server under test behaves appropriately. -
operation
TestScript.TestScriptSetupActionOperationComponent operation
The operation to perform.
-
-
Class org.hl7.fhir.dstu2.model.TestScript.TestScriptSetupActionOperationComponent
class TestScriptSetupActionOperationComponent extends BackboneElement implements Serializable- serialVersionUID:
- -590188078L
-
Serialized Fields
-
accept
Enumeration<TestScript.ContentType> accept
The content-type or mime-type to use for RESTful operation in the 'Accept' header. -
contentType
Enumeration<TestScript.ContentType> contentType
The content-type or mime-type to use for RESTful operation in the 'Content-Type' header. -
description
StringType description
The description would be used by test engines for tracking and reporting purposes. -
destination
IntegerType destination
Which server to perform the operation on. -
encodeRequestUrl
BooleanType encodeRequestUrl
Whether or not to implicitly send the request url in encoded format. The default is true to match the standard RESTful client behavior. Set to false when communicating with a server that does not support encoded url paths. -
label
StringType label
The label would be used for tracking/logging purposes by test engines. -
params
StringType params
Path plus parameters after [type]. Used to set parts of the request URL explicitly. -
requestHeader
List<TestScript.TestScriptSetupActionOperationRequestHeaderComponent> requestHeader
Header elements would be used to set HTTP headers. -
resource
CodeType resource
The type of the resource. See http://hl7-fhir.github.io/resourcelist.html. -
responseId
IdType responseId
The fixture id (maybe new) to map to the response. -
sourceId
IdType sourceId
The id of the fixture used as the body of a PUT or POST request. -
targetId
IdType targetId
Id of fixture used for extracting the [id], [type], and [vid] for GET requests. -
type
Coding type
Server interaction or operation type. -
url
StringType url
Complete request URL.
-
-
Class org.hl7.fhir.dstu2.model.TestScript.TestScriptSetupActionOperationRequestHeaderComponent
class TestScriptSetupActionOperationRequestHeaderComponent extends BackboneElement implements Serializable- serialVersionUID:
- 274395337L
-
Serialized Fields
-
field
StringType field
The HTTP header field e.g. "Accept". -
value
StringType value
The value of the header e.g. "application/xml".
-
-
Class org.hl7.fhir.dstu2.model.TestScript.TestScriptSetupComponent
class TestScriptSetupComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1836543723L
-
Serialized Fields
-
action
List<TestScript.TestScriptSetupActionComponent> action
Action would contain either an operation or an assertion. -
metadata
TestScript.TestScriptMetadataComponent metadata
Capabilities that must exist and are assumed to function correctly on the FHIR server being tested.
-
-
Class org.hl7.fhir.dstu2.model.TestScript.TestScriptTeardownActionComponent
class TestScriptTeardownActionComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1684092023L
-
Serialized Fields
-
operation
TestScript.TestScriptSetupActionOperationComponent operation
An operation would involve a REST request to a server.
-
-
Class org.hl7.fhir.dstu2.model.TestScript.TestScriptTeardownComponent
class TestScriptTeardownComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1850225254L
-
Serialized Fields
-
action
List<TestScript.TestScriptTeardownActionComponent> action
The teardown action will only contain an operation.
-
-
Class org.hl7.fhir.dstu2.model.TestScript.TestScriptTestActionComponent
class TestScriptTestActionComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1411550037L
-
Serialized Fields
-
assert_
TestScript.TestScriptSetupActionAssertComponent assert_
Evaluates the results of previous operations to determine if the server under test behaves appropriately. -
operation
TestScript.TestScriptSetupActionOperationComponent operation
An operation would involve a REST request to a server.
-
-
Class org.hl7.fhir.dstu2.model.TestScript.TestScriptTestComponent
class TestScriptTestComponent extends BackboneElement implements Serializable- serialVersionUID:
- 408339297L
-
Serialized Fields
-
action
List<TestScript.TestScriptTestActionComponent> action
Action would contain either an operation or an assertion. -
description
StringType description
A short description of the test used by test engines for tracking and reporting purposes. -
metadata
TestScript.TestScriptMetadataComponent metadata
Capabilities that must exist and are assumed to function correctly on the FHIR server being tested. -
name
StringType name
The name of this test used for tracking/logging purposes by test engines.
-
-
Class org.hl7.fhir.dstu2.model.TestScript.TestScriptVariableComponent
class TestScriptVariableComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1128806685L
-
Serialized Fields
-
headerField
StringType headerField
Will be used to grab the HTTP header field value from the headers that sourceId is pointing to. -
name
StringType name
Descriptive name for this variable. -
path
StringType path
XPath or JSONPath against the fixture body. When variables are defined, either headerField must be specified or path, but not both. -
sourceId
IdType sourceId
Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.
-
-
Class org.hl7.fhir.dstu2.model.TimeType
- serialVersionUID:
- 3L
-
Class org.hl7.fhir.dstu2.model.Timing
class Timing extends Type implements Serializable- serialVersionUID:
- 791565112L
-
Serialized Fields
-
code
CodeableConcept code
A code for the timing pattern. Some codes such as BID are ubiquitous, but many institutions define their own additional codes. -
event
List<DateTimeType> event
Identifies specific times when the event occurs. -
repeat
Timing.TimingRepeatComponent repeat
A set of rules that describe when the event should occur.
-
-
Class org.hl7.fhir.dstu2.model.Timing.EventTimingEnumFactory
class EventTimingEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Timing.TimingRepeatComponent
class TimingRepeatComponent extends Element implements Serializable- serialVersionUID:
- -585686982L
-
Serialized Fields
-
bounds
Type bounds
Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule. -
count
IntegerType count
A total count of the desired number of repetitions. -
duration
DecimalType duration
How long this thing happens for when it happens. -
durationMax
DecimalType durationMax
The upper limit of how long this thing happens for when it happens. -
durationUnits
Enumeration<Timing.UnitsOfTime> durationUnits
The units of time for the duration, in UCUM units. -
frequency
IntegerType frequency
The number of times to repeat the action within the specified period / period range (i.e. both period and periodMax provided). -
frequencyMax
IntegerType frequencyMax
If present, indicates that the frequency is a range - so repeat between [frequency] and [frequencyMax] times within the period or period range. -
period
DecimalType period
Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. -
periodMax
DecimalType periodMax
If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days. -
periodUnits
Enumeration<Timing.UnitsOfTime> periodUnits
The units of time for the period in UCUM units. -
when
Enumeration<Timing.EventTiming> when
A real world event that the occurrence of the event should be tied to.
-
-
Class org.hl7.fhir.dstu2.model.Timing.UnitsOfTimeEnumFactory
class UnitsOfTimeEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.Type
class Type extends Element implements Serializable- serialVersionUID:
- 4623040030733049991L
-
Class org.hl7.fhir.dstu2.model.UnsignedIntType
class UnsignedIntType extends IntegerType implements Serializable- serialVersionUID:
- -7991875974606711355L
-
Class org.hl7.fhir.dstu2.model.UriType
- serialVersionUID:
- 3L
-
Class org.hl7.fhir.dstu2.model.UuidType
class UuidType extends UriType implements Serializable- serialVersionUID:
- 3L
-
Class org.hl7.fhir.dstu2.model.ValueSet
class ValueSet extends DomainResource implements Serializable- serialVersionUID:
- -467533312L
-
Serialized Fields
-
codeSystem
ValueSet.ValueSetCodeSystemComponent codeSystem
A definition of a code system, inlined into the value set (as a packaging convenience). Note that the inline code system may be used from other value sets by referring to its (codeSystem.system) directly. -
compose
ValueSet.ValueSetComposeComponent compose
A set of criteria that provide the content logical definition of the value set by including or excluding codes from outside this value set. -
contact
List<ValueSet.ValueSetContactComponent> contact
Contacts to assist a user in finding and communicating with the publisher. -
copyright
StringType copyright
A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set. -
date
DateTimeType date
The date that the value set status was last changed. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes (e.g. the 'content logical definition'). -
description
StringType description
A free text natural language description of the use of the value set - reason for definition, "the semantic space" to be included in the value set, conditions of use, etc. The description may include a list of expected usages for the value set and can also describe the approach taken to build the value set. -
expansion
ValueSet.ValueSetExpansionComponent expansion
A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed. -
experimental
BooleanType experimental
This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. -
extensible
BooleanType extensible
Whether this is intended to be used with an extensible binding or not. -
identifier
Identifier identifier
Formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance. -
immutable
BooleanType immutable
If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change. -
lockedDate
DateType lockedDate
If a locked date is defined, then the Content Logical Definition must be evaluated using the current version of all referenced code system(s) and value set instances as of the locked date. -
name
StringType name
A free text natural language name describing the value set. -
publisher
StringType publisher
The name of the individual or organization that published the value set. -
requirements
StringType requirements
Explains why this value set is needed and why it has been constrained as it has. -
status
Enumeration<Enumerations.ConformanceResourceStatus> status
The status of the value set. -
url
UriType url
An absolute URL that is used to identify this value set when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this value set is (or will be) published. -
useContext
List<CodeableConcept> useContext
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of value set definitions. -
version
StringType version
Used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.
-
-
Class org.hl7.fhir.dstu2.model.ValueSet.ConceptDefinitionComponent
class ConceptDefinitionComponent extends BackboneElement implements Serializable- serialVersionUID:
- -318560292L
-
Serialized Fields
-
abstract_
BooleanType abstract_
If this code is not for use as a real concept. -
code
CodeType code
A code - a text symbol - that uniquely identifies the concept within the code system. -
concept
List<ValueSet.ConceptDefinitionComponent> concept
Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) and can only be determined by examining the definitions of the concepts. -
definition
StringType definition
The formal definition of the concept. The value set 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<ValueSet.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.
-
-
Class org.hl7.fhir.dstu2.model.ValueSet.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.dstu2.model.ValueSet.ConceptReferenceComponent
class ConceptReferenceComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1513912691L
-
Serialized Fields
-
code
CodeType code
Specifies a code for the concept to be included or excluded. -
designation
List<ValueSet.ConceptDefinitionDesignationComponent> designation
Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc. -
display
StringType display
The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system.
-
-
Class org.hl7.fhir.dstu2.model.ValueSet.ConceptSetComponent
class ConceptSetComponent extends BackboneElement implements Serializable- serialVersionUID:
- -196054471L
-
Serialized Fields
-
concept
List<ValueSet.ConceptReferenceComponent> concept
Specifies a concept to be included or excluded. -
filter
List<ValueSet.ConceptSetFilterComponent> filter
Select concepts by specify a matching criteria based on the properties (including relationships) defined by the system. If multiple filters are specified, they SHALL all be true. -
system
UriType system
An absolute URI which is the code system from which the selected codes come from. -
version
StringType version
The version of the code system that the codes are selected from.
-
-
Class org.hl7.fhir.dstu2.model.ValueSet.ConceptSetFilterComponent
class ConceptSetFilterComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1985515000L
-
Serialized Fields
-
op
Enumeration<ValueSet.FilterOperator> op
The kind of operation to perform as a part of the filter criteria. -
property
CodeType property
A code that identifies a property defined in the code system. -
value
CodeType value
The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value.
-
-
Class org.hl7.fhir.dstu2.model.ValueSet.FilterOperatorEnumFactory
class FilterOperatorEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.ValueSet.ValueSetCodeSystemComponent
class ValueSetCodeSystemComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1109401192L
-
Serialized Fields
-
caseSensitive
BooleanType caseSensitive
If code comparison is case sensitive when codes within this system are compared to each other. -
concept
List<ValueSet.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. -
system
UriType system
An absolute URI that is used to reference this code system, including in [Coding]{datatypes.html#Coding}.system. -
version
StringType version
The version of this code system that defines the codes. Note that the version is optional because a well maintained code system does not suffer from versioning, and therefore the version does not need to be maintained. However many code systems are not well maintained, and the version needs to be defined and tracked.
-
-
Class org.hl7.fhir.dstu2.model.ValueSet.ValueSetComposeComponent
class ValueSetComposeComponent extends BackboneElement implements Serializable- serialVersionUID:
- -703166694L
-
Serialized Fields
-
exclude
List<ValueSet.ConceptSetComponent> exclude
Exclude one or more codes from the value set. -
import_
List<UriType> import_
Includes the contents of the referenced value set as a part of the contents of this value set. This is an absolute URI that is a reference to ValueSet.uri. -
include
List<ValueSet.ConceptSetComponent> include
Include one or more codes from a code system.
-
-
Class org.hl7.fhir.dstu2.model.ValueSet.ValueSetContactComponent
class ValueSetContactComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1179697803L
-
Serialized Fields
-
name
StringType name
The name of an individual to contact regarding the value set. -
telecom
List<ContactPoint> telecom
Contact details for individual (if a name was provided) or the publisher.
-
-
Class org.hl7.fhir.dstu2.model.ValueSet.ValueSetExpansionComponent
class ValueSetExpansionComponent extends BackboneElement implements Serializable- serialVersionUID:
- -43471993L
-
Serialized Fields
-
contains
List<ValueSet.ValueSetExpansionContainsComponent> contains
The codes that are contained in the value set expansion. -
identifier
UriType identifier
An identifier that uniquely identifies this expansion of the valueset. Systems may re-use the same identifier as long as the expansion and the definition remain the same, but are not required to do so. -
offset
IntegerType offset
If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL not be present. -
parameter
List<ValueSet.ValueSetExpansionParameterComponent> parameter
A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion. -
timestamp
DateTimeType timestamp
The time at which the expansion was produced by the expanding system. -
total
IntegerType total
The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter.
-
-
Class org.hl7.fhir.dstu2.model.ValueSet.ValueSetExpansionContainsComponent
class ValueSetExpansionContainsComponent extends BackboneElement implements Serializable- serialVersionUID:
- -2038349483L
-
Serialized Fields
-
abstract_
BooleanType abstract_
If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value. -
code
CodeType code
The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set. -
contains
List<ValueSet.ValueSetExpansionContainsComponent> contains
Other codes and entries contained under this entry in the hierarchy. -
display
StringType display
The recommended display for this item in the expansion. -
system
UriType system
An absolute URI which is the code system in which the code for this item in the expansion is defined. -
version
StringType version
The version of this code system that defined this code and/or display. This should only be used with code systems that do not enforce concept permanence.
-
-
Class org.hl7.fhir.dstu2.model.ValueSet.ValueSetExpansionParameterComponent
class ValueSetExpansionParameterComponent extends BackboneElement implements Serializable- serialVersionUID:
- 1172641169L
-
Serialized Fields
-
name
StringType name
The name of the parameter. -
value
Type value
The value of the parameter.
-
-
Class org.hl7.fhir.dstu2.model.VisionPrescription
class VisionPrescription extends DomainResource implements Serializable- serialVersionUID:
- -1108276057L
-
Serialized Fields
-
dateWritten
DateTimeType dateWritten
The date (and perhaps time) when the prescription was written. -
dispense
List<VisionPrescription.VisionPrescriptionDispenseComponent> dispense
Deals with details of the dispense part of the supply specification. -
encounter
Reference encounter
A link to a resource that identifies the particular occurrence of contact between patient and health care provider. -
encounterTarget
Encounter encounterTarget
The actual object that is the target of the reference (A link to a resource that identifies the particular occurrence of contact between patient and health care provider.) -
identifier
List<Identifier> identifier
Business identifier which may be used by other parties to reference or identify the prescription. -
patient
Reference patient
A link to a resource representing the person to whom the vision products will be supplied. -
patientTarget
Patient patientTarget
The actual object that is the target of the reference (A link to a resource representing the person to whom the vision products will be supplied.) -
prescriber
Reference prescriber
The healthcare professional responsible for authorizing the prescription. -
prescriberTarget
Practitioner prescriberTarget
The actual object that is the target of the reference (The healthcare professional responsible for authorizing the prescription.) -
reason
Type reason
Can be the reason or the indication for writing the prescription.
-
-
Class org.hl7.fhir.dstu2.model.VisionPrescription.VisionBaseEnumFactory
class VisionBaseEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.VisionPrescription.VisionEyesEnumFactory
class VisionEyesEnumFactory extends Object implements Serializable -
Class org.hl7.fhir.dstu2.model.VisionPrescription.VisionPrescriptionDispenseComponent
class VisionPrescriptionDispenseComponent extends BackboneElement implements Serializable- serialVersionUID:
- -1586392610L
-
Serialized Fields
-
add
DecimalType add
Power adjustment for multifocal lenses measured in diopters (0.25 units). -
axis
IntegerType axis
Adjustment for astigmatism measured in integer degrees. -
backCurve
DecimalType backCurve
Back curvature measured in millimeters. -
base
Enumeration<VisionPrescription.VisionBase> base
The relative base, or reference lens edge, for the prism. -
brand
StringType brand
Brand recommendations or restrictions. -
color
StringType color
Special color or pattern. -
cylinder
DecimalType cylinder
Power adjustment for astigmatism measured in diopters (0.25 units). -
diameter
DecimalType diameter
Contact lens diameter measured in millimeters. -
duration
SimpleQuantity duration
The recommended maximum wear period for the lens. -
eye
Enumeration<VisionPrescription.VisionEyes> eye
The eye for which the lens applies. -
notes
StringType notes
Notes for special requirements such as coatings and lens materials. -
power
DecimalType power
Contact lens power measured in diopters (0.25 units). -
prism
DecimalType prism
Amount of prism to compensate for eye alignment in fractional units. -
product
Coding product
Identifies the type of vision correction product which is required for the patient. -
sphere
DecimalType sphere
Lens power measured in diopters (0.25 units).
-
-
-
Package org.hl7.fhir.dstu2.terminologies
-
Exception Class org.hl7.fhir.dstu2.terminologies.ValueSetExpander.ETooCostly
class ETooCostly extends Exception implements Serializable
-
-
Package org.hl7.fhir.dstu2.utils
-
Exception Class org.hl7.fhir.dstu2.utils.EOperationOutcome
class EOperationOutcome extends Exception implements Serializable- serialVersionUID:
- 8887222532359256131L
-
Serialized Fields
-
outcome
OperationOutcome outcome
-
-
Exception Class org.hl7.fhir.dstu2.utils.FHIRLexer.FHIRLexerException
class FHIRLexerException extends org.hl7.fhir.exceptions.FHIRException implements Serializable
-
-
Package org.hl7.fhir.dstu2.utils.client
-
Exception Class org.hl7.fhir.dstu2.utils.client.EFhirClientException
class EFhirClientException extends RuntimeException implements Serializable- serialVersionUID:
- 1L
-
Serialized Fields
-
errors
List<OperationOutcome> errors
-
-