Serialized Form

  • Package org.hl7.fhir.r4.elementmodel

  • Package org.hl7.fhir.r4.model

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

      class Account extends DomainResource implements Serializable
      serialVersionUID:
      1211238069L
      • Serialized Fields

        • coverage
          List<Account.CoverageComponent> coverage
          The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.
        • description
          StringType description
          Provides additional information about what the account tracks and how it is used.
        • guarantor
          List<Account.GuarantorComponent> guarantor
          The parties responsible for balancing the account if other payment options fall short.
        • identifier
          List<Identifier> identifier
          Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number).
        • name
          StringType name
          Name used for the account when displaying it to humans in reports, etc.
        • owner
          Reference owner
          Indicates the service area, hospital, department, etc. with responsibility for managing the Account.
        • ownerTarget
          Organization ownerTarget
          The actual object that is the target of the reference (Indicates the service area, hospital, department, etc. with responsibility for managing the Account.)
        • partOf
          Reference partOf
          Reference to a parent Account.
        • partOfTarget
          Account partOfTarget
          The actual object that is the target of the reference (Reference to a parent Account.)
        • servicePeriod
          Period servicePeriod
          The date range of services associated with this account.
        • status
          Enumeration<Account.AccountStatus> status
          Indicates whether the account is presently used/usable or not.
        • subject
          List<Reference> subject
          Identifies the entity which incurs the expenses. While the immediate recipients of services or goods might be entities related to the subject, the expenses were ultimately incurred by the subject of the Account.
        • subjectTarget
          List<Resource> subjectTarget
          The actual objects that are the target of the reference (Identifies the entity which incurs the expenses. While the immediate recipients of services or goods might be entities related to the subject, the expenses were ultimately incurred by the subject of the Account.)
        • type
          CodeableConcept type
          Categorizes the account for reporting and searching purposes.
    • Class org.hl7.fhir.r4.model.Account.AccountStatusEnumFactory

      class AccountStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Account.CoverageComponent

      class CoverageComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1046265008L
      • Serialized Fields

        • coverage
          Reference coverage
          The party(s) that contribute to payment (or part of) of the charges applied to this account (including self-pay). A coverage may only be responsible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing.
        • coverageTarget
          Coverage coverageTarget
          The actual object that is the target of the reference (The party(s) that contribute to payment (or part of) of the charges applied to this account (including self-pay). A coverage may only be responsible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing.)
        • priority
          PositiveIntType priority
          The priority of the coverage in the context of this account.
    • Class org.hl7.fhir.r4.model.Account.GuarantorComponent

      class GuarantorComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1012345396L
      • Serialized Fields

        • onHold
          BooleanType onHold
          A guarantor may be placed on credit hold or otherwise have their role temporarily suspended.
        • party
          Reference party
          The entity who is responsible.
        • partyTarget
          Resource partyTarget
          The actual object that is the target of the reference (The entity who is responsible.)
        • period
          Period period
          The timeframe during which the guarantor accepts responsibility for the account.
    • Class org.hl7.fhir.r4.model.ActivityDefinition

      class ActivityDefinition extends MetadataResource implements Serializable
      serialVersionUID:
      1488459022L
      • Serialized Fields

        • approvalDate
          DateType approvalDate
          The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
        • author
          List<ContactDetail> author
          An individiual or organization primarily involved in the creation and maintenance of the content.
        • bodySite
          List<CodeableConcept> bodySite
          Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).
        • code
          CodeableConcept code
          Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
        • copyright
          MarkdownType copyright
          A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.
        • doNotPerform
          BooleanType doNotPerform
          Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.
        • dosage
          List<Dosage> dosage
          Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.
        • dynamicValue
          List<ActivityDefinition.ActivityDefinitionDynamicValueComponent> dynamicValue
          Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.
        • editor
          List<ContactDetail> editor
          An individual or organization primarily responsible for internal coherence of the content.
        • effectivePeriod
          Period effectivePeriod
          The period during which the activity definition content was or is planned to be in active use.
        • endorser
          List<ContactDetail> endorser
          An individual or organization responsible for officially endorsing the content for use in some setting.
        • identifier
          List<Identifier> identifier
          A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
        • intent
          Enumeration<ActivityDefinition.RequestIntent> intent
          Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.
        • kind
          Enumeration<ActivityDefinition.ActivityDefinitionKind> kind
          A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.
        • lastReviewDate
          DateType lastReviewDate
          The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
        • library
          List<CanonicalType> library
          A reference to a Library resource containing any formal logic used by the activity definition.
        • location
          Reference location
          Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
        • locationTarget
          Location locationTarget
          The actual object that is the target of the reference (Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)
        • observationRequirement
          List<Reference> observationRequirement
          Defines observation requirements for the action to be performed, such as body weight or surface area.
        • observationRequirementTarget
          List<ObservationDefinition> observationRequirementTarget
          The actual objects that are the target of the reference (Defines observation requirements for the action to be performed, such as body weight or surface area.)
        • observationResultRequirement
          List<Reference> observationResultRequirement
          Defines the observations that are expected to be produced by the action.
        • observationResultRequirementTarget
          List<ObservationDefinition> observationResultRequirementTarget
          The actual objects that are the target of the reference (Defines the observations that are expected to be produced by the action.)
        • participant
          List<ActivityDefinition.ActivityDefinitionParticipantComponent> participant
          Indicates who should participate in performing the action described.
        • priority
          Enumeration<ActivityDefinition.RequestPriority> priority
          Indicates how quickly the activity should be addressed with respect to other requests.
        • product
          Type product
          Identifies the food, drug or other product being consumed or supplied in the activity.
        • profile
          CanonicalType profile
          A profile to which the target of the activity definition is expected to conform.
        • purpose
          MarkdownType purpose
          Explanation of why this activity definition is needed and why it has been designed as it has.
        • quantity
          Quantity quantity
          Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).
        • relatedArtifact
          List<RelatedArtifact> relatedArtifact
          Related artifacts such as additional documentation, justification, or bibliographic references.
        • reviewer
          List<ContactDetail> reviewer
          An individual or organization primarily responsible for review of some aspect of the content.
        • specimenRequirement
          List<Reference> specimenRequirement
          Defines specimen requirements for the action to be performed, such as required specimens for a lab test.
        • specimenRequirementTarget
          List<SpecimenDefinition> specimenRequirementTarget
          The actual objects that are the target of the reference (Defines specimen requirements for the action to be performed, such as required specimens for a lab test.)
        • subject
          Type subject
          A code or group definition that describes the intended subject of the activity being defined.
        • subtitle
          StringType subtitle
          An explanatory or alternate title for the activity definition giving additional information about its content.
        • timing
          Type timing
          The period, timing or frequency upon which the described activity is to occur.
        • topic
          List<CodeableConcept> topic
          Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.
        • transform
          CanonicalType transform
          A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
        • usage
          StringType usage
          A detailed description of how the activity definition is used from a clinical perspective.
    • Class org.hl7.fhir.r4.model.ActivityDefinition.ActivityDefinitionDynamicValueComponent

      class ActivityDefinitionDynamicValueComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1064529082L
      • Serialized Fields

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

      class ActivityDefinitionKindEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.ActivityDefinition.ActivityDefinitionParticipantComponent

      class ActivityDefinitionParticipantComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1450932564L
    • Class org.hl7.fhir.r4.model.ActivityDefinition.ActivityParticipantTypeEnumFactory

      class ActivityParticipantTypeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.ActivityDefinition.RequestIntentEnumFactory

      class RequestIntentEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.ActivityDefinition.RequestPriorityEnumFactory

      class RequestPriorityEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Address

      class Address extends Type implements Serializable
      serialVersionUID:
      561490318L
      • Serialized Fields

        • city
          StringType city
          The name of the city, town, suburb, village or other community or delivery center.
        • country
          StringType country
          Country - a nation as commonly understood or generally accepted.
        • district
          StringType district
          The name of the administrative area (county).
        • line
          List<StringType> line
          This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
        • period
          Period period
          Time period when address was/is in use.
        • postalCode
          StringType postalCode
          A postal code designating a region defined by the postal service.
        • state
          StringType state
          Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).
        • text
          StringType text
          Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.
        • type
          Enumeration<Address.AddressType> type
          Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
        • use
          Enumeration<Address.AddressUse> use
          The purpose of this address.
    • Class org.hl7.fhir.r4.model.Address.AddressTypeEnumFactory

      class AddressTypeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Address.AddressUseEnumFactory

      class AddressUseEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.AdverseEvent

      class AdverseEvent extends DomainResource implements Serializable
      serialVersionUID:
      -2055195281L
      • Serialized Fields

        • actuality
          Enumeration<AdverseEvent.AdverseEventActuality> actuality
          Whether the event actually happened, or just had the potential to. Note that this is independent of whether anyone was affected or harmed or how severely.
        • category
          List<CodeableConcept> category
          The overall type of event, intended for search and filtering purposes.
        • contributor
          List<Reference> contributor
          Parties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness).
        • contributorTarget
          List<Resource> contributorTarget
          The actual objects that are the target of the reference (Parties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness).)
        • date
          DateTimeType date
          The date (and perhaps time) when the adverse event occurred.
        • detected
          DateTimeType detected
          Estimated or actual date the AdverseEvent began, in the opinion of the reporter.
        • encounter
          Reference encounter
          The Encounter during which AdverseEvent was created or to which the creation of this record is tightly associated.
        • encounterTarget
          Encounter encounterTarget
          The actual object that is the target of the reference (The Encounter during which AdverseEvent was created or to which the creation of this record is tightly associated.)
        • event
          CodeableConcept event
          This element defines the specific type of event that occurred or that was prevented from occurring.
        • identifier
          Identifier identifier
          Business identifiers assigned to this adverse event by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
        • location
          Reference location
          The information about where the adverse event occurred.
        • locationTarget
          Location locationTarget
          The actual object that is the target of the reference (The information about where the adverse event occurred.)
        • outcome
          CodeableConcept outcome
          Describes the type of outcome from the adverse event.
        • recordedDate
          DateTimeType recordedDate
          The date on which the existence of the AdverseEvent was first recorded.
        • recorder
          Reference recorder
          Information on who recorded the adverse event. May be the patient or a practitioner.
        • recorderTarget
          Resource recorderTarget
          The actual object that is the target of the reference (Information on who recorded the adverse event. May be the patient or a practitioner.)
        • referenceDocument
          List<Reference> referenceDocument
          AdverseEvent.referenceDocument.
        • referenceDocumentTarget
          List<DocumentReference> referenceDocumentTarget
          The actual objects that are the target of the reference (AdverseEvent.referenceDocument.)
        • resultingCondition
          List<Reference> resultingCondition
          Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).
        • resultingConditionTarget
          List<Condition> resultingConditionTarget
          The actual objects that are the target of the reference (Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).)
        • seriousness
          CodeableConcept seriousness
          Assessment whether this event was of real importance.
        • severity
          CodeableConcept severity
          Describes the severity of the adverse event, in relation to the subject. Contrast to AdverseEvent.seriousness - a severe rash might not be serious, but a mild heart problem is.
        • study
          List<Reference> study
          AdverseEvent.study.
        • studyTarget
          List<ResearchStudy> studyTarget
          The actual objects that are the target of the reference (AdverseEvent.study.)
        • subject
          Reference subject
          This subject or group impacted by the event.
        • subjectMedicalHistory
          List<Reference> subjectMedicalHistory
          AdverseEvent.subjectMedicalHistory.
        • subjectMedicalHistoryTarget
          List<Resource> subjectMedicalHistoryTarget
          The actual objects that are the target of the reference (AdverseEvent.subjectMedicalHistory.)
        • subjectTarget
          Resource subjectTarget
          The actual object that is the target of the reference (This subject or group impacted by the event.)
        • suspectEntity
          List<AdverseEvent.AdverseEventSuspectEntityComponent> suspectEntity
          Describes the entity that is suspected to have caused the adverse event.
    • Class org.hl7.fhir.r4.model.AdverseEvent.AdverseEventActualityEnumFactory

      class AdverseEventActualityEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.AdverseEvent.AdverseEventSuspectEntityCausalityComponent

      class AdverseEventSuspectEntityCausalityComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1847234837L
      • Serialized Fields

        • assessment
          CodeableConcept assessment
          Assessment of if the entity caused the event.
        • author
          Reference author
          AdverseEvent.suspectEntity.causalityAuthor.
        • authorTarget
          Resource authorTarget
          The actual object that is the target of the reference (AdverseEvent.suspectEntity.causalityAuthor.)
        • method
          CodeableConcept method
          ProbabilityScale | Bayesian | Checklist.
        • productRelatedness
          StringType productRelatedness
          AdverseEvent.suspectEntity.causalityProductRelatedness.
    • Class org.hl7.fhir.r4.model.AdverseEvent.AdverseEventSuspectEntityComponent

      class AdverseEventSuspectEntityComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1245759325L
      • Serialized Fields

        • causality
          List<AdverseEvent.AdverseEventSuspectEntityCausalityComponent> causality
          Information on the possible cause of the event.
        • instance
          Reference instance
          Identifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device.
        • instanceTarget
          Resource instanceTarget
          The actual object that is the target of the reference (Identifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device.)
    • Class org.hl7.fhir.r4.model.Age

      class Age extends Quantity implements Serializable
      serialVersionUID:
      0L
    • Class org.hl7.fhir.r4.model.AllergyIntolerance

      class AllergyIntolerance extends DomainResource implements Serializable
      serialVersionUID:
      393192289L
      • Serialized Fields

        • asserter
          Reference asserter
          The source of the information about the allergy that is recorded.
        • asserterTarget
          Resource asserterTarget
          The actual object that is the target of the reference (The source of the information about the allergy that is recorded.)
        • category
          List<Enumeration<AllergyIntolerance.AllergyIntoleranceCategory>> category
          Category of the identified substance.
        • clinicalStatus
          CodeableConcept clinicalStatus
          The clinical status of the allergy or intolerance.
        • code
          CodeableConcept code
          Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"), or a negated/excluded code for a specific substance or class (e.g., "No latex allergy") or a general or categorical negated statement (e.g., "No known allergy", "No known drug allergies"). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.
        • criticality
          Enumeration<AllergyIntolerance.AllergyIntoleranceCriticality> criticality
          Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.
        • encounter
          Reference encounter
          The encounter when the allergy or intolerance was asserted.
        • encounterTarget
          Encounter encounterTarget
          The actual object that is the target of the reference (The encounter when the allergy or intolerance was asserted.)
        • identifier
          List<Identifier> identifier
          Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
        • lastOccurrence
          DateTimeType lastOccurrence
          Represents the date and/or time of the last known occurrence of a reaction event.
        • note
          List<Annotation> note
          Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.
        • onset
          Type onset
          Estimated or actual date, date-time, or age when allergy or intolerance was identified.
        • patient
          Reference patient
          The patient who has the allergy or intolerance.
        • patientTarget
          Patient patientTarget
          The actual object that is the target of the reference (The patient who has the allergy or intolerance.)
        • reaction
          List<AllergyIntolerance.AllergyIntoleranceReactionComponent> reaction
          Details about each adverse reaction event linked to exposure to the identified substance.
        • recordedDate
          DateTimeType recordedDate
          The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.
        • recorder
          Reference recorder
          Individual who recorded the record and takes responsibility for its content.
        • recorderTarget
          Resource recorderTarget
          The actual object that is the target of the reference (Individual who recorded the record and takes responsibility for its content.)
        • type
          Enumeration<AllergyIntolerance.AllergyIntoleranceType> type
          Identification of the underlying physiological mechanism for the reaction risk.
        • verificationStatus
          CodeableConcept verificationStatus
          Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).
    • Class org.hl7.fhir.r4.model.AllergyIntolerance.AllergyIntoleranceCategoryEnumFactory

      class AllergyIntoleranceCategoryEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.AllergyIntolerance.AllergyIntoleranceCriticalityEnumFactory

      class AllergyIntoleranceCriticalityEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.AllergyIntolerance.AllergyIntoleranceReactionComponent

      class AllergyIntoleranceReactionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -752118516L
      • Serialized Fields

        • description
          StringType description
          Text description about the reaction as a whole, including details of the manifestation if required.
        • exposureRoute
          CodeableConcept exposureRoute
          Identification of the route by which the subject was exposed to the substance.
        • manifestation
          List<CodeableConcept> manifestation
          Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.
        • note
          List<Annotation> note
          Additional text about the adverse reaction event not captured in other fields.
        • onset
          DateTimeType onset
          Record of the date and/or time of the onset of the Reaction.
        • severity
          Enumeration<AllergyIntolerance.AllergyIntoleranceSeverity> severity
          Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.
        • substance
          CodeableConcept substance
          Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.
    • Class org.hl7.fhir.r4.model.AllergyIntolerance.AllergyIntoleranceSeverityEnumFactory

      class AllergyIntoleranceSeverityEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.AllergyIntolerance.AllergyIntoleranceTypeEnumFactory

      class AllergyIntoleranceTypeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Annotation

      class Annotation extends Type implements Serializable
      serialVersionUID:
      1324090545L
      • Serialized Fields

        • author
          Type author
          The individual responsible for making the annotation.
        • text
          MarkdownType text
          The text of the annotation in markdown format.
        • time
          DateTimeType time
          Indicates when this particular annotation was made.
    • Class org.hl7.fhir.r4.model.Appointment

      class Appointment extends DomainResource implements Serializable
      serialVersionUID:
      -1096822339L
      • Serialized Fields

        • appointmentType
          CodeableConcept appointmentType
          The style of appointment or patient that has been booked in the slot (not service type).
        • basedOn
          List<Reference> basedOn
          The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).
        • basedOnTarget
          List<ServiceRequest> basedOnTarget
          The actual objects that are the target of the reference (The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).)
        • cancelationReason
          CodeableConcept cancelationReason
          The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.
        • comment
          StringType comment
          Additional comments about the appointment.
        • created
          DateTimeType created
          The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.
        • description
          StringType description
          The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.
        • end
          InstantType end
          Date/Time that the appointment is to conclude.
        • identifier
          List<Identifier> identifier
          This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
        • minutesDuration
          PositiveIntType minutesDuration
          Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.
        • participant
          List<Appointment.AppointmentParticipantComponent> participant
          List of participants involved in the appointment.
        • patientInstruction
          StringType patientInstruction
          While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).
        • priority
          UnsignedIntType priority
          The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).
        • reasonCode
          List<CodeableConcept> reasonCode
          The coded reason that this appointment is being scheduled. This is more clinical than administrative.
        • reasonReference
          List<Reference> reasonReference
          Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
        • reasonReferenceTarget
          List<Resource> reasonReferenceTarget
          The actual objects that are the target of the reference (Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.)
        • requestedPeriod
          List<Period> requestedPeriod
          A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.
        • serviceCategory
          List<CodeableConcept> serviceCategory
          A broad categorization of the service that is to be performed during this appointment.
        • serviceType
          List<CodeableConcept> serviceType
          The specific service that is to be performed during this appointment.
        • slot
          List<Reference> slot
          The slots from the participants' schedules that will be filled by the appointment.
        • slotTarget
          List<Slot> slotTarget
          The actual objects that are the target of the reference (The slots from the participants' schedules that will be filled by the appointment.)
        • specialty
          List<CodeableConcept> specialty
          The specialty of a practitioner that would be required to perform the service requested in this appointment.
        • start
          InstantType start
          Date/Time that the appointment is to take place.
        • status
          Enumeration<Appointment.AppointmentStatus> status
          The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.
        • supportingInformation
          List<Reference> supportingInformation
          Additional information to support the appointment provided when making the appointment.
        • supportingInformationTarget
          List<Resource> supportingInformationTarget
          The actual objects that are the target of the reference (Additional information to support the appointment provided when making the appointment.)
    • Class org.hl7.fhir.r4.model.Appointment.AppointmentParticipantComponent

      class AppointmentParticipantComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1939292177L
      • Serialized Fields

        • actor
          Reference actor
          A Person, Location/HealthcareService or Device that is participating in the appointment.
        • actorTarget
          Resource actorTarget
          The actual object that is the target of the reference (A Person, Location/HealthcareService or Device that is participating in the appointment.)
        • period
          Period period
          Participation period of the actor.
        • required
          Enumeration<Appointment.ParticipantRequired> required
          Whether this participant is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.
        • status
          Enumeration<Appointment.ParticipationStatus> status
          Participation status of the actor.
        • type
          List<CodeableConcept> type
          Role of participant in the appointment.
    • Class org.hl7.fhir.r4.model.Appointment.AppointmentStatusEnumFactory

      class AppointmentStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Appointment.ParticipantRequiredEnumFactory

      class ParticipantRequiredEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Appointment.ParticipationStatusEnumFactory

      class ParticipationStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.AppointmentResponse

      class AppointmentResponse extends DomainResource implements Serializable
      serialVersionUID:
      248548635L
      • Serialized Fields

        • actor
          Reference actor
          A Person, Location, HealthcareService, or Device that is participating in the appointment.
        • actorTarget
          Resource actorTarget
          The actual object that is the target of the reference (A Person, Location, HealthcareService, or Device that is participating in the appointment.)
        • appointment
          Reference appointment
          Appointment that this response is replying to.
        • appointmentTarget
          Appointment appointmentTarget
          The actual object that is the target of the reference (Appointment that this response is replying to.)
        • comment
          StringType comment
          Additional comments about the appointment.
        • end
          InstantType end
          This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.
        • identifier
          List<Identifier> identifier
          This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate.
        • participantStatus
          Enumeration<AppointmentResponse.ParticipantStatus> participantStatus
          Participation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.
        • participantType
          List<CodeableConcept> participantType
          Role of participant in the appointment.
        • start
          InstantType start
          Date/Time that the appointment is to take place, or requested new start time.
    • Class org.hl7.fhir.r4.model.AppointmentResponse.ParticipantStatusEnumFactory

      class ParticipantStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Attachment

      class Attachment extends Type implements Serializable
      serialVersionUID:
      -564352571L
      • Serialized Fields

        • contentType
          CodeType contentType
          Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.
        • creation
          DateTimeType creation
          The date that the attachment was first created.
        • data
          Base64BinaryType data
          The actual data of the attachment - a sequence of bytes, base64 encoded.
        • hash
          Base64BinaryType hash
          The calculated hash of the data using SHA-1. Represented using base64.
        • language
          CodeType language
          The human language of the content. The value can be any valid value according to BCP 47.
        • size
          UnsignedIntType size
          The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
        • title
          StringType title
          A label or set of text to display in place of the data.
        • url
          UrlType url
          A location where the data can be accessed.
    • Class org.hl7.fhir.r4.model.AuditEvent

      class AuditEvent extends DomainResource implements Serializable
      serialVersionUID:
      106433685L
    • Class org.hl7.fhir.r4.model.AuditEvent.AuditEventActionEnumFactory

      class AuditEventActionEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.AuditEvent.AuditEventAgentComponent

      class AuditEventAgentComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -957410638L
      • Serialized Fields

        • altId
          StringType altId
          Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available.
        • location
          Reference location
          Where the event occurred.
        • locationTarget
          Location locationTarget
          The actual object that is the target of the reference (Where the event occurred.)
        • media
          Coding media
          Type of media involved. Used when the event is about exporting/importing onto media.
        • name
          StringType name
          Human-meaningful name for the agent.
        • network
          AuditEvent.AuditEventAgentNetworkComponent network
          Logical network location for application activity, if the activity has a network location.
        • policy
          List<UriType> policy
          The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.
        • purposeOfUse
          List<CodeableConcept> purposeOfUse
          The reason (purpose of use), specific to this agent, that was used during the event being recorded.
        • requestor
          BooleanType requestor
          Indicator that the user is or is not the requestor, or initiator, for the event being audited.
        • role
          List<CodeableConcept> role
          The security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.
        • type
          CodeableConcept type
          Specification of the participation type the user plays when performing the event.
        • who
          Reference who
          Reference to who this agent is that was involved in the event.
        • whoTarget
          Resource whoTarget
          The actual object that is the target of the reference (Reference to who this agent is that was involved in the event.)
    • Class org.hl7.fhir.r4.model.AuditEvent.AuditEventAgentNetworkComponent

      class AuditEventAgentNetworkComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -160715924L
    • Class org.hl7.fhir.r4.model.AuditEvent.AuditEventAgentNetworkTypeEnumFactory

      class AuditEventAgentNetworkTypeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.AuditEvent.AuditEventEntityComponent

      class AuditEventEntityComponent extends BackboneElement implements Serializable
      serialVersionUID:
      334545686L
      • Serialized Fields

        • description
          StringType description
          Text that describes the entity in more detail.
        • detail
          List<AuditEvent.AuditEventEntityDetailComponent> detail
          Tagged value pairs for conveying additional information about the entity.
        • lifecycle
          Coding lifecycle
          Identifier for the data life-cycle stage for the entity.
        • name
          StringType name
          A name of the entity in the audit event.
        • query
          Base64BinaryType query
          The query parameters for a query-type entities.
        • role
          Coding role
          Code representing the role the entity played in the event being audited.
        • securityLabel
          List<Coding> securityLabel
          Security labels for the identified entity.
        • type
          Coding type
          The type of the object that was involved in this audit event.
        • what
          Reference what
          Identifies a specific instance of the entity. The reference should be version specific.
        • whatTarget
          Resource whatTarget
          The actual object that is the target of the reference (Identifies a specific instance of the entity. The reference should be version specific.)
    • Class org.hl7.fhir.r4.model.AuditEvent.AuditEventEntityDetailComponent

      class AuditEventEntityDetailComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1035059584L
      • Serialized Fields

        • type
          StringType type
          The type of extra detail provided in the value.
        • value
          Type value
          The value of the extra detail.
    • Class org.hl7.fhir.r4.model.AuditEvent.AuditEventOutcomeEnumFactory

      class AuditEventOutcomeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.AuditEvent.AuditEventSourceComponent

      class AuditEventSourceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      2133038564L
      • Serialized Fields

        • observer
          Reference observer
          Identifier of the source where the event was detected.
        • observerTarget
          Resource observerTarget
          The actual object that is the target of the reference (Identifier of the source where the event was detected.)
        • site
          StringType site
          Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group.
        • type
          List<Coding> type
          Code specifying the type of source where event originated.
    • Class org.hl7.fhir.r4.model.BackboneElement

      class BackboneElement extends Element implements Serializable
      serialVersionUID:
      -1431673179L
      • Serialized Fields

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

      class BackboneType extends Type implements Serializable
      serialVersionUID:
      -1431673179L
      • Serialized Fields

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

      class Base extends Object implements Serializable
      • Serialized Fields

        • formatCommentsPost
          List<String> formatCommentsPost
          Round tracking xml comments for testing convenience
        • formatCommentsPre
          List<String> formatCommentsPre
          Round tracking xml comments for testing convenience
        • userData
          Map<String,Object> userData
          User appended data items - allow users to add extra information to the class
    • Class org.hl7.fhir.r4.model.Base64BinaryType

      class Base64BinaryType extends PrimitiveType<byte[]> implements Externalizable
      serialVersionUID:
      3L
    • Class org.hl7.fhir.r4.model.BaseBinary

      class BaseBinary extends Resource implements Serializable
      serialVersionUID:
      1L
    • Class org.hl7.fhir.r4.model.BaseDateTimeType

      class BaseDateTimeType extends PrimitiveType<Date> implements Externalizable
      serialVersionUID:
      1L
    • Class org.hl7.fhir.r4.model.BaseExtension

      class BaseExtension extends Type implements Serializable
      serialVersionUID:
      1L
    • Class org.hl7.fhir.r4.model.BaseNarrative

      class BaseNarrative extends Type implements Serializable
    • Class org.hl7.fhir.r4.model.BaseReference

      class BaseReference extends Type implements Serializable
    • Class org.hl7.fhir.r4.model.BaseResource

      class BaseResource extends Base implements Serializable
      serialVersionUID:
      1L
    • Class org.hl7.fhir.r4.model.Basic

      class Basic extends DomainResource implements Serializable
      serialVersionUID:
      650756402L
      • Serialized Fields

        • author
          Reference author
          Indicates who was responsible for creating the resource instance.
        • authorTarget
          Resource authorTarget
          The actual object that is the target of the reference (Indicates who was responsible for creating the resource instance.)
        • code
          CodeableConcept code
          Identifies the 'type' of resource - equivalent to the resource name for other resources.
        • created
          DateType created
          Identifies when the resource was first created.
        • identifier
          List<Identifier> identifier
          Identifier assigned to the resource for business purposes, outside the context of FHIR.
        • subject
          Reference subject
          Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.
        • subjectTarget
          Resource subjectTarget
          The actual object that is the target of the reference (Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.)
    • Class org.hl7.fhir.r4.model.Binary

      class Binary extends BaseBinary implements Serializable
      serialVersionUID:
      1353224198L
      • Serialized Fields

        • contentType
          CodeType contentType
          MimeType of the binary content represented as a standard MimeType (BCP 13).
        • data
          Base64BinaryType data
          The actual content, base64 encoded.
        • securityContext
          Reference securityContext
          This element identifies another resource that can be used as a proxy of the security sensitivity to use when deciding and enforcing access control rules for the Binary resource. Given that the Binary resource contains very few elements that can be used to determine the sensitivity of the data and relationships to individuals, the referenced resource stands in as a proxy equivalent for this purpose. This referenced resource may be related to the Binary (e.g. Media, DocumentReference), or may be some non-related Resource purely as a security proxy. E.g. to identify that the binary resource relates to a patient, and access should only be granted to applications that have access to the patient.
        • securityContextTarget
          Resource securityContextTarget
          The actual object that is the target of the reference (This element identifies another resource that can be used as a proxy of the security sensitivity to use when deciding and enforcing access control rules for the Binary resource. Given that the Binary resource contains very few elements that can be used to determine the sensitivity of the data and relationships to individuals, the referenced resource stands in as a proxy equivalent for this purpose. This referenced resource may be related to the Binary (e.g. Media, DocumentReference), or may be some non-related Resource purely as a security proxy. E.g. to identify that the binary resource relates to a patient, and access should only be granted to applications that have access to the patient.)
    • Class org.hl7.fhir.r4.model.BiologicallyDerivedProduct

      class BiologicallyDerivedProduct extends DomainResource implements Serializable
      serialVersionUID:
      -1367034547L
    • Class org.hl7.fhir.r4.model.BiologicallyDerivedProduct.BiologicallyDerivedProductCategoryEnumFactory

      class BiologicallyDerivedProductCategoryEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.BiologicallyDerivedProduct.BiologicallyDerivedProductCollectionComponent

      class BiologicallyDerivedProductCollectionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      892130089L
      • Serialized Fields

        • collected
          Type collected
          Time of product collection.
        • collector
          Reference collector
          Healthcare professional who is performing the collection.
        • collectorTarget
          Resource collectorTarget
          The actual object that is the target of the reference (Healthcare professional who is performing the collection.)
        • source
          Reference source
          The patient or entity, such as a hospital or vendor in the case of a processed/manipulated/manufactured product, providing the product.
        • sourceTarget
          Resource sourceTarget
          The actual object that is the target of the reference (The patient or entity, such as a hospital or vendor in the case of a processed/manipulated/manufactured product, providing the product.)
    • Class org.hl7.fhir.r4.model.BiologicallyDerivedProduct.BiologicallyDerivedProductManipulationComponent

      class BiologicallyDerivedProductManipulationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      717201078L
      • Serialized Fields

        • description
          StringType description
          Description of manipulation.
        • time
          Type time
          Time of manipulation.
    • Class org.hl7.fhir.r4.model.BiologicallyDerivedProduct.BiologicallyDerivedProductProcessingComponent

      class BiologicallyDerivedProductProcessingComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1007041216L
      • Serialized Fields

        • additive
          Reference additive
          Substance added during processing.
        • additiveTarget
          Substance additiveTarget
          The actual object that is the target of the reference (Substance added during processing.)
        • description
          StringType description
          Description of of processing.
        • procedure
          CodeableConcept procedure
          Procesing code.
        • time
          Type time
          Time of processing.
    • Class org.hl7.fhir.r4.model.BiologicallyDerivedProduct.BiologicallyDerivedProductStatusEnumFactory

      class BiologicallyDerivedProductStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.BiologicallyDerivedProduct.BiologicallyDerivedProductStorageComponent

      class BiologicallyDerivedProductStorageComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1509141319L
    • Class org.hl7.fhir.r4.model.BiologicallyDerivedProduct.BiologicallyDerivedProductStorageScaleEnumFactory

      class BiologicallyDerivedProductStorageScaleEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.BodyStructure

      class BodyStructure extends DomainResource implements Serializable
      serialVersionUID:
      1437500387L
      • Serialized Fields

        • active
          BooleanType active
          Whether this body site is in active use.
        • description
          StringType description
          A summary, characterization or explanation of the body structure.
        • identifier
          List<Identifier> identifier
          Identifier for this instance of the anatomical structure.
        • image
          List<Attachment> image
          Image or images used to identify a location.
        • location
          CodeableConcept location
          The anatomical location or region of the specimen, lesion, or body structure.
        • locationQualifier
          List<CodeableConcept> locationQualifier
          Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.
        • morphology
          CodeableConcept morphology
          The kind of structure being represented by the body structure at `BodyStructure.location`. This can define both normal and abnormal morphologies.
        • patient
          Reference patient
          The person to which the body site belongs.
        • patientTarget
          Patient patientTarget
          The actual object that is the target of the reference (The person to which the body site belongs.)
    • Class org.hl7.fhir.r4.model.BooleanType

      class BooleanType extends PrimitiveType<Boolean> implements Externalizable
      serialVersionUID:
      3L
    • Class org.hl7.fhir.r4.model.Bundle

      class Bundle extends Resource implements Serializable
      serialVersionUID:
      1740470158L
      • Serialized Fields

        • entry
          List<Bundle.BundleEntryComponent> entry
          An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
        • identifier
          Identifier identifier
          A persistent identifier for the bundle that won't change as a bundle is copied from server to server.
        • link
          List<Bundle.BundleLinkComponent> link
          A series of links that provide context to this bundle.
        • signature
          Signature signature
          Digital Signature - base64 encoded. XML-DSig or a JWT.
        • timestamp
          InstantType timestamp
          The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.
        • total
          UnsignedIntType total
          If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.
        • type
          Enumeration<Bundle.BundleType> type
          Indicates the purpose of this bundle - how it is intended to be used.
    • Class org.hl7.fhir.r4.model.Bundle.BundleEntryComponent

      class BundleEntryComponent extends BackboneElement implements Serializable
      serialVersionUID:
      517783054L
      • Serialized Fields

        • fullUrl
          UriType fullUrl
          The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle) Results from operations might involve resources that are not identified.
        • link
          List<Bundle.BundleLinkComponent> link
          A series of links that provide context to this entry.
        • request
          Bundle.BundleEntryRequestComponent request
          Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.
        • resource
          Resource resource
          The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.
        • response
          Bundle.BundleEntryResponseComponent response
          Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.
        • search
          Bundle.BundleEntrySearchComponent search
          Information about the search process that lead to the creation of this entry.
    • Class org.hl7.fhir.r4.model.Bundle.BundleEntryRequestComponent

      class BundleEntryRequestComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1349769744L
      • Serialized Fields

        • ifMatch
          StringType ifMatch
          Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).
        • ifModifiedSince
          InstantType ifModifiedSince
          Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).
        • ifNoneExist
          StringType ifNoneExist
          Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").
        • ifNoneMatch
          StringType ifNoneMatch
          If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).
        • method
          Enumeration<Bundle.HTTPVerb> method
          In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.
        • url
          UriType url
          The URL for this entry, relative to the root (the address to which the request is posted).
    • Class org.hl7.fhir.r4.model.Bundle.BundleEntryResponseComponent

      class BundleEntryResponseComponent extends BackboneElement implements Serializable
      serialVersionUID:
      923278008L
      • Serialized Fields

        • etag
          StringType etag
          The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).
        • lastModified
          InstantType lastModified
          The date/time that the resource was modified on the server.
        • location
          UriType location
          The location header created by processing this operation, populated if the operation returns a location.
        • outcome
          Resource outcome
          An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.
        • status
          StringType status
          The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.
    • Class org.hl7.fhir.r4.model.Bundle.BundleEntrySearchComponent

      class BundleEntrySearchComponent extends BackboneElement implements Serializable
      serialVersionUID:
      837739866L
      • Serialized Fields

        • mode
          Enumeration<Bundle.SearchEntryMode> mode
          Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
        • score
          DecimalType score
          When searching, the server's search ranking score for the entry.
    • Class org.hl7.fhir.r4.model.Bundle.BundleLinkComponent

      class BundleLinkComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1010386066L
      • Serialized Fields

        • relation
          StringType relation
          A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1).
        • url
          UriType url
          The reference details for the link.
    • Class org.hl7.fhir.r4.model.Bundle.BundleTypeEnumFactory

      class BundleTypeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Bundle.HTTPVerbEnumFactory

      class HTTPVerbEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Bundle.SearchEntryModeEnumFactory

      class SearchEntryModeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CanonicalType

      class CanonicalType extends UriType implements Externalizable
      serialVersionUID:
      4L
    • Class org.hl7.fhir.r4.model.CapabilityStatement

      class CapabilityStatement extends MetadataResource implements Serializable
      serialVersionUID:
      -1050288843L
      • Serialized Fields

        • copyright
          MarkdownType copyright
          A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.
        • document
          List<CapabilityStatement.CapabilityStatementDocumentComponent> document
          A document definition.
        • fhirVersion
          Enumeration<Enumerations.FHIRVersion> fhirVersion
          The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value.
        • format
          List<CodeType> format
          A list of the formats supported by this implementation using their content types.
        • implementation
          CapabilityStatement.CapabilityStatementImplementationComponent implementation
          Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.
        • implementationGuide
          List<CanonicalType> implementationGuide
          A list of implementation guides that the server does (or should) support in their entirety.
        • imports
          List<CanonicalType> imports
          Reference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them.
        • instantiates
          List<CanonicalType> instantiates
          Reference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details.
        • kind
          Enumeration<CapabilityStatement.CapabilityStatementKind> kind
          The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).
        • messaging
          List<CapabilityStatement.CapabilityStatementMessagingComponent> messaging
          A description of the messaging capabilities of the solution.
        • patchFormat
          List<CodeType> patchFormat
          A list of the patch formats supported by this implementation using their content types.
        • purpose
          MarkdownType purpose
          Explanation of why this capability statement is needed and why it has been designed as it has.
        • rest
          List<CapabilityStatement.CapabilityStatementRestComponent> rest
          A definition of the restful capabilities of the solution, if any.
        • software
          CapabilityStatement.CapabilityStatementSoftwareComponent software
          Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.
    • Class org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementDocumentComponent

      class CapabilityStatementDocumentComponent extends BackboneElement implements Serializable
      serialVersionUID:
      18026632L
      • Serialized Fields

        • documentation
          MarkdownType documentation
          A description of how the application supports or uses the specified document profile. For example, when documents are created, what action is taken with consumed documents, etc.
        • mode
          Enumeration<CapabilityStatement.DocumentMode> mode
          Mode of this document declaration - whether an application is a producer or consumer.
        • profile
          CanonicalType profile
          A profile on the document Bundle that constrains which resources are present, and their contents.
    • Class org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementImplementationComponent

      class CapabilityStatementImplementationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1705695694L
      • Serialized Fields

        • custodian
          Reference custodian
          The organization responsible for the management of the instance and oversight of the data on the server at the specified URL.
        • custodianTarget
          Organization custodianTarget
          The actual object that is the target of the reference (The organization responsible for the management of the instance and oversight of the data on the server at the specified URL.)
        • description
          StringType description
          Information about the specific installation that this capability statement relates to.
        • url
          UrlType url
          An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.
    • Class org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementKindEnumFactory

      class CapabilityStatementKindEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementMessagingComponent

      class CapabilityStatementMessagingComponent extends BackboneElement implements Serializable
      serialVersionUID:
      300411231L
    • Class org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementMessagingEndpointComponent

      class CapabilityStatementMessagingEndpointComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -236946103L
      • Serialized Fields

        • address
          UrlType address
          The network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier.
        • protocol
          Coding protocol
          A list of the messaging transport protocol(s) identifiers, supported by this endpoint.
    • Class org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementMessagingSupportedMessageComponent

      class CapabilityStatementMessagingSupportedMessageComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1172840676L
    • Class org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementRestComponent

      class CapabilityStatementRestComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1442029817L
    • Class org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementRestResourceComponent

      class CapabilityStatementRestResourceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1843372337L
      • Serialized Fields

        • conditionalCreate
          BooleanType conditionalCreate
          A flag that indicates that the server supports conditional create.
        • conditionalDelete
          Enumeration<CapabilityStatement.ConditionalDeleteStatus> conditionalDelete
          A code that indicates how the server supports conditional delete.
        • conditionalRead
          Enumeration<CapabilityStatement.ConditionalReadStatus> conditionalRead
          A code that indicates how the server supports conditional read.
        • conditionalUpdate
          BooleanType conditionalUpdate
          A flag that indicates that the server supports conditional update.
        • documentation
          MarkdownType documentation
          Additional information about the resource type used by the system.
        • interaction
          List<CapabilityStatement.ResourceInteractionComponent> interaction
          Identifies a restful operation supported by the solution.
        • operation
          List<CapabilityStatement.CapabilityStatementRestResourceOperationComponent> operation
          Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters.
        • profile
          CanonicalType profile
          A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles](profiling.html#profile-uses).
        • readHistory
          BooleanType readHistory
          A flag for whether the server is able to return past versions as part of the vRead operation.
        • referencePolicy
          List<Enumeration<CapabilityStatement.ReferenceHandlingPolicy>> referencePolicy
          A set of flags that defines how references are supported.
        • searchInclude
          List<StringType> searchInclude
          A list of _include values supported by the server.
        • searchParam
          List<CapabilityStatement.CapabilityStatementRestResourceSearchParamComponent> searchParam
          Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.
        • searchRevInclude
          List<StringType> searchRevInclude
          A list of _revinclude (reverse include) values supported by the server.
        • supportedProfile
          List<CanonicalType> supportedProfile
          A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses).
        • type
          CodeType type
          A type of resource exposed via the restful interface.
        • updateCreate
          BooleanType updateCreate
          A flag to indicate that the server allows or needs to allow the client to create new identities on the server (that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server.
        • versioning
          Enumeration<CapabilityStatement.ResourceVersionPolicy> versioning
          This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API.
    • Class org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementRestResourceOperationComponent

      class CapabilityStatementRestResourceOperationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -388608084L
      • Serialized Fields

        • definition
          CanonicalType definition
          Where the formal definition can be found. If a server references the base definition of an Operation (i.e. from the specification itself such as ```http://hl7.org/fhir/OperationDefinition/ValueSet-expand```), that means it supports the full capabilities of the operation - e.g. both GET and POST invocation. If it only supports a subset, it must define its own custom [[[OperationDefinition]]] with a 'base' of the original OperationDefinition. The custom definition would describe the specific subset of functionality supported.
        • documentation
          MarkdownType documentation
          Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation.
        • name
          StringType name
          The name of the operation or query. For an operation, this is the name prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called.
    • Class org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementRestResourceSearchParamComponent

      class CapabilityStatementRestResourceSearchParamComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -171123928L
      • Serialized Fields

        • definition
          CanonicalType definition
          An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]]). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.
        • documentation
          MarkdownType documentation
          This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.
        • name
          StringType name
          The name of the search parameter used in the interface.
        • type
          Enumeration<Enumerations.SearchParamType> type
          The type of value a search parameter refers to, and how the content is interpreted.
    • Class org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementRestSecurityComponent

      class CapabilityStatementRestSecurityComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1348900500L
      • Serialized Fields

        • cors
          BooleanType cors
          Server adds CORS headers when responding to requests - this enables Javascript applications to use the server.
        • description
          MarkdownType description
          General description of how security works.
        • service
          List<CodeableConcept> service
          Types of security services that are supported/required by the system.
    • Class org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementSoftwareComponent

      class CapabilityStatementSoftwareComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1819769027L
      • Serialized Fields

        • name
          StringType name
          Name the software is known by.
        • releaseDate
          DateTimeType releaseDate
          Date this version of the software was released.
        • version
          StringType version
          The version identifier for the software covered by this statement.
    • Class org.hl7.fhir.r4.model.CapabilityStatement.ConditionalDeleteStatusEnumFactory

      class ConditionalDeleteStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CapabilityStatement.ConditionalReadStatusEnumFactory

      class ConditionalReadStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CapabilityStatement.DocumentModeEnumFactory

      class DocumentModeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CapabilityStatement.EventCapabilityModeEnumFactory

      class EventCapabilityModeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CapabilityStatement.ReferenceHandlingPolicyEnumFactory

      class ReferenceHandlingPolicyEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CapabilityStatement.ResourceInteractionComponent

      class ResourceInteractionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      2128937796L
      • Serialized Fields

        • code
          Enumeration<CapabilityStatement.TypeRestfulInteraction> code
          Coded identifier of the operation, supported by the system resource.
        • documentation
          MarkdownType documentation
          Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'.
    • Class org.hl7.fhir.r4.model.CapabilityStatement.ResourceVersionPolicyEnumFactory

      class ResourceVersionPolicyEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CapabilityStatement.RestfulCapabilityModeEnumFactory

      class RestfulCapabilityModeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CapabilityStatement.SystemInteractionComponent

      class SystemInteractionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1495143879L
      • Serialized Fields

        • code
          Enumeration<CapabilityStatement.SystemRestfulInteraction> code
          A coded identifier of the operation, supported by the system.
        • documentation
          MarkdownType documentation
          Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented.
    • Class org.hl7.fhir.r4.model.CapabilityStatement.SystemRestfulInteractionEnumFactory

      class SystemRestfulInteractionEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CapabilityStatement.TypeRestfulInteractionEnumFactory

      class TypeRestfulInteractionEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CarePlan

      class CarePlan extends DomainResource implements Serializable
      serialVersionUID:
      -584930613L
      • Serialized Fields

        • activity
          List<CarePlan.CarePlanActivityComponent> activity
          Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.
        • addresses
          List<Reference> addresses
          Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
        • addressesTarget
          List<Condition> addressesTarget
          The actual objects that are the target of the reference (Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.)
        • author
          Reference author
          When populated, the author is responsible for the care plan. The care plan is attributed to the author.
        • authorTarget
          Resource authorTarget
          The actual object that is the target of the reference (When populated, the author is responsible for the care plan. The care plan is attributed to the author.)
        • basedOn
          List<Reference> basedOn
          A care plan that is fulfilled in whole or in part by this care plan.
        • basedOnTarget
          List<CarePlan> basedOnTarget
          The actual objects that are the target of the reference (A care plan that is fulfilled in whole or in part by this care plan.)
        • careTeam
          List<Reference> careTeam
          Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
        • careTeamTarget
          List<CareTeam> careTeamTarget
          The actual objects that are the target of the reference (Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.)
        • category
          List<CodeableConcept> category
          Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.
        • contributor
          List<Reference> contributor
          Identifies the individual(s) or organization who provided the contents of the care plan.
        • contributorTarget
          List<Resource> contributorTarget
          The actual objects that are the target of the reference (Identifies the individual(s) or organization who provided the contents of the care plan.)
        • created
          DateTimeType created
          Represents when this particular CarePlan record was created in the system, which is often a system-generated date.
        • description
          StringType description
          A description of the scope and nature of the plan.
        • encounter
          Reference encounter
          The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.
        • encounterTarget
          Encounter encounterTarget
          The actual object that is the target of the reference (The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.)
        • goal
          List<Reference> goal
          Describes the intended objective(s) of carrying out the care plan.
        • goalTarget
          List<Goal> goalTarget
          The actual objects that are the target of the reference (Describes the intended objective(s) of carrying out the care plan.)
        • identifier
          List<Identifier> identifier
          Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
        • instantiatesCanonical
          List<CanonicalType> instantiatesCanonical
          The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
        • instantiatesUri
          List<UriType> instantiatesUri
          The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
        • intent
          Enumeration<CarePlan.CarePlanIntent> intent
          Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.
        • note
          List<Annotation> note
          General notes about the care plan not covered elsewhere.
        • partOf
          List<Reference> partOf
          A larger care plan of which this particular care plan is a component or step.
        • partOfTarget
          List<CarePlan> partOfTarget
          The actual objects that are the target of the reference (A larger care plan of which this particular care plan is a component or step.)
        • period
          Period period
          Indicates when the plan did (or is intended to) come into effect and end.
        • replaces
          List<Reference> replaces
          Completed or terminated care plan whose function is taken by this new care plan.
        • replacesTarget
          List<CarePlan> replacesTarget
          The actual objects that are the target of the reference (Completed or terminated care plan whose function is taken by this new care plan.)
        • status
          Enumeration<CarePlan.CarePlanStatus> status
          Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
        • subject
          Reference subject
          Identifies the patient or group whose intended care is described by the plan.
        • subjectTarget
          Resource subjectTarget
          The actual object that is the target of the reference (Identifies the patient or group whose intended care is described by the plan.)
        • supportingInfo
          List<Reference> supportingInfo
          Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.
        • supportingInfoTarget
          List<Resource> supportingInfoTarget
          The actual objects that are the target of the reference (Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.)
        • title
          StringType title
          Human-friendly name for the care plan.
    • Class org.hl7.fhir.r4.model.CarePlan.CarePlanActivityComponent

      class CarePlanActivityComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -609287300L
      • Serialized Fields

        • detail
          CarePlan.CarePlanActivityDetailComponent detail
          A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.
        • outcomeCodeableConcept
          List<CodeableConcept> outcomeCodeableConcept
          Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).
        • outcomeReference
          List<Reference> outcomeReference
          Details of the outcome or action resulting from the activity. The reference to an "event" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a ?request? resource).
        • outcomeReferenceTarget
          List<Resource> outcomeReferenceTarget
          The actual objects that are the target of the reference (Details of the outcome or action resulting from the activity. The reference to an "event" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a ?request? resource).)
        • progress
          List<Annotation> progress
          Notes about the adherence/status/progress of the activity.
        • reference
          Reference reference
          The details of the proposed activity represented in a specific resource.
        • referenceTarget
          Resource referenceTarget
          The actual object that is the target of the reference (The details of the proposed activity represented in a specific resource.)
    • Class org.hl7.fhir.r4.model.CarePlan.CarePlanActivityDetailComponent

      class CarePlanActivityDetailComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1355568081L
      • Serialized Fields

        • code
          CodeableConcept code
          Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter.
        • dailyAmount
          Quantity dailyAmount
          Identifies the quantity expected to be consumed in a given day.
        • description
          StringType description
          This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.
        • doNotPerform
          BooleanType doNotPerform
          If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan.
        • goal
          List<Reference> goal
          Internal reference that identifies the goals that this activity is intended to contribute towards meeting.
        • goalTarget
          List<Goal> goalTarget
          The actual objects that are the target of the reference (Internal reference that identifies the goals that this activity is intended to contribute towards meeting.)
        • instantiatesCanonical
          List<CanonicalType> instantiatesCanonical
          The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.
        • instantiatesUri
          List<UriType> instantiatesUri
          The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.
        • kind
          Enumeration<CarePlan.CarePlanActivityKind> kind
          A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.
        • location
          Reference location
          Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
        • locationTarget
          Location locationTarget
          The actual object that is the target of the reference (Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)
        • performer
          List<Reference> performer
          Identifies who's expected to be involved in the activity.
        • performerTarget
          List<Resource> performerTarget
          The actual objects that are the target of the reference (Identifies who's expected to be involved in the activity.)
        • product
          Type product
          Identifies the food, drug or other product to be consumed or supplied in the activity.
        • quantity
          Quantity quantity
          Identifies the quantity expected to be supplied, administered or consumed by the subject.
        • reasonCode
          List<CodeableConcept> reasonCode
          Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.
        • reasonReference
          List<Reference> reasonReference
          Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan.
        • reasonReferenceTarget
          List<Resource> reasonReferenceTarget
          The actual objects that are the target of the reference (Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan.)
        • scheduled
          Type scheduled
          The period, timing or frequency upon which the described activity is to occur.
        • status
          Enumeration<CarePlan.CarePlanActivityStatus> status
          Identifies what progress is being made for the specific activity.
        • statusReason
          CodeableConcept statusReason
          Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.
    • Class org.hl7.fhir.r4.model.CarePlan.CarePlanActivityKindEnumFactory

      class CarePlanActivityKindEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CarePlan.CarePlanActivityStatusEnumFactory

      class CarePlanActivityStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CarePlan.CarePlanIntentEnumFactory

      class CarePlanIntentEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CarePlan.CarePlanStatusEnumFactory

      class CarePlanStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CareTeam

      class CareTeam extends DomainResource implements Serializable
      serialVersionUID:
      1793069286L
      • Serialized Fields

        • category
          List<CodeableConcept> category
          Identifies what kind of team. This is to support differentiation between multiple co-existing teams, such as care plan team, episode of care team, longitudinal care team.
        • encounter
          Reference encounter
          The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.
        • encounterTarget
          Encounter encounterTarget
          The actual object that is the target of the reference (The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.)
        • identifier
          List<Identifier> identifier
          Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
        • managingOrganization
          List<Reference> managingOrganization
          The organization responsible for the care team.
        • managingOrganizationTarget
          List<Organization> managingOrganizationTarget
          The actual objects that are the target of the reference (The organization responsible for the care team.)
        • name
          StringType name
          A label for human use intended to distinguish like teams. E.g. the "red" vs. "green" trauma teams.
        • note
          List<Annotation> note
          Comments made about the CareTeam.
        • participant
          List<CareTeam.CareTeamParticipantComponent> participant
          Identifies all people and organizations who are expected to be involved in the care team.
        • period
          Period period
          Indicates when the team did (or is intended to) come into effect and end.
        • reasonCode
          List<CodeableConcept> reasonCode
          Describes why the care team exists.
        • reasonReference
          List<Reference> reasonReference
          Condition(s) that this care team addresses.
        • reasonReferenceTarget
          List<Condition> reasonReferenceTarget
          The actual objects that are the target of the reference (Condition(s) that this care team addresses.)
        • status
          Enumeration<CareTeam.CareTeamStatus> status
          Indicates the current state of the care team.
        • subject
          Reference subject
          Identifies the patient or group whose intended care is handled by the team.
        • subjectTarget
          Resource subjectTarget
          The actual object that is the target of the reference (Identifies the patient or group whose intended care is handled by the team.)
        • telecom
          List<ContactPoint> telecom
          A central contact detail for the care team (that applies to all members).
    • Class org.hl7.fhir.r4.model.CareTeam.CareTeamParticipantComponent

      class CareTeamParticipantComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -575634410L
      • Serialized Fields

        • member
          Reference member
          The specific person or organization who is participating/expected to participate in the care team.
        • memberTarget
          Resource memberTarget
          The actual object that is the target of the reference (The specific person or organization who is participating/expected to participate in the care team.)
        • onBehalfOf
          Reference onBehalfOf
          The organization of the practitioner.
        • onBehalfOfTarget
          Organization onBehalfOfTarget
          The actual object that is the target of the reference (The organization of the practitioner.)
        • period
          Period period
          Indicates when the specific member or organization did (or is intended to) come into effect and end.
        • role
          List<CodeableConcept> role
          Indicates specific responsibility of an individual within the care team, such as "Primary care physician", "Trained social worker counselor", "Caregiver", etc.
    • Class org.hl7.fhir.r4.model.CareTeam.CareTeamStatusEnumFactory

      class CareTeamStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CatalogEntry

      class CatalogEntry extends DomainResource implements Serializable
      serialVersionUID:
      57448275L
      • Serialized Fields

        • additionalCharacteristic
          List<CodeableConcept> additionalCharacteristic
          Used for examplefor Out of Formulary, or any specifics.
        • additionalClassification
          List<CodeableConcept> additionalClassification
          User for example for ATC classification, or.
        • additionalIdentifier
          List<Identifier> additionalIdentifier
          Used in supporting related concepts, e.g. NDC to RxNorm.
        • classification
          List<CodeableConcept> classification
          Classes of devices, or ATC for medication.
        • identifier
          List<Identifier> identifier
          Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.
        • lastUpdated
          DateTimeType lastUpdated
          Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.
        • orderable
          BooleanType orderable
          Whether the entry represents an orderable item.
        • referencedItem
          Reference referencedItem
          The item in a catalog or definition.
        • referencedItemTarget
          Resource referencedItemTarget
          The actual object that is the target of the reference (The item in a catalog or definition.)
        • relatedEntry
          List<CatalogEntry.CatalogEntryRelatedEntryComponent> relatedEntry
          Used for example, to point to a substance, or to a device used to administer a medication.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.
        • type
          CodeableConcept type
          The type of item - medication, device, service, protocol or other.
        • validityPeriod
          Period validityPeriod
          The time period in which this catalog entry is expected to be active.
        • validTo
          DateTimeType validTo
          The date until which this catalog entry is expected to be active.
    • Class org.hl7.fhir.r4.model.CatalogEntry.CatalogEntryRelatedEntryComponent

      class CatalogEntryRelatedEntryComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1367020813L
      • Serialized Fields

        • item
          Reference item
          The reference to the related item.
        • itemTarget
          CatalogEntry itemTarget
          The actual object that is the target of the reference (The reference to the related item.)
        • relationtype
          Enumeration<CatalogEntry.CatalogEntryRelationType> relationtype
          The type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc.
    • Class org.hl7.fhir.r4.model.CatalogEntry.CatalogEntryRelationTypeEnumFactory

      class CatalogEntryRelationTypeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.ChargeItem

      class ChargeItem extends DomainResource implements Serializable
      serialVersionUID:
      1748644267L
      • Serialized Fields

        • account
          List<Reference> account
          Account into which this ChargeItems belongs.
        • accountTarget
          List<Account> accountTarget
          The actual objects that are the target of the reference (Account into which this ChargeItems belongs.)
        • bodysite
          List<CodeableConcept> bodysite
          The anatomical location where the related service has been applied.
        • code
          CodeableConcept code
          A code that identifies the charge, like a billing code.
        • context
          Reference context
          The encounter or episode of care that establishes the context for this event.
        • contextTarget
          Resource contextTarget
          The actual object that is the target of the reference (The encounter or episode of care that establishes the context for this event.)
        • costCenter
          Reference costCenter
          The financial cost center permits the tracking of charge attribution.
        • costCenterTarget
          Organization costCenterTarget
          The actual object that is the target of the reference (The financial cost center permits the tracking of charge attribution.)
        • definitionCanonical
          List<CanonicalType> definitionCanonical
          References the source of pricing information, rules of application for the code this ChargeItem uses.
        • definitionUri
          List<UriType> definitionUri
          References the (external) source of pricing information, rules of application for the code this ChargeItem uses.
        • enteredDate
          DateTimeType enteredDate
          Date the charge item was entered.
        • enterer
          Reference enterer
          The device, practitioner, etc. who entered the charge item.
        • entererTarget
          Resource entererTarget
          The actual object that is the target of the reference (The device, practitioner, etc. who entered the charge item.)
        • factorOverride
          DecimalType factorOverride
          Factor overriding the factor determined by the rules associated with the code.
        • identifier
          List<Identifier> identifier
          Identifiers assigned to this event performer or other systems.
        • note
          List<Annotation> note
          Comments made about the event by the performer, subject or other participants.
        • occurrence
          Type occurrence
          Date/time(s) or duration when the charged service was applied.
        • overrideReason
          StringType overrideReason
          If the list price or the rule-based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action.
        • partOf
          List<Reference> partOf
          ChargeItems can be grouped to larger ChargeItems covering the whole set.
        • partOfTarget
          List<ChargeItem> partOfTarget
          The actual objects that are the target of the reference (ChargeItems can be grouped to larger ChargeItems covering the whole set.)
        • performer
          List<ChargeItem.ChargeItemPerformerComponent> performer
          Indicates who or what performed or participated in the charged service.
        • performingOrganization
          Reference performingOrganization
          The organization requesting the service.
        • performingOrganizationTarget
          Organization performingOrganizationTarget
          The actual object that is the target of the reference (The organization requesting the service.)
        • priceOverride
          Money priceOverride
          Total price of the charge overriding the list price associated with the code.
        • product
          Type product
          Identifies the device, food, drug or other product being charged either by type code or reference to an instance.
        • quantity
          Quantity quantity
          Quantity of which the charge item has been serviced.
        • reason
          List<CodeableConcept> reason
          Describes why the event occurred in coded or textual form.
        • requestingOrganization
          Reference requestingOrganization
          The organization performing the service.
        • requestingOrganizationTarget
          Organization requestingOrganizationTarget
          The actual object that is the target of the reference (The organization performing the service.)
        • service
          List<Reference> service
          Indicated the rendered service that caused this charge.
        • serviceTarget
          List<Resource> serviceTarget
          The actual objects that are the target of the reference (Indicated the rendered service that caused this charge.)
        • status
          Enumeration<ChargeItem.ChargeItemStatus> status
          The current state of the ChargeItem.
        • subject
          Reference subject
          The individual or set of individuals the action is being or was performed on.
        • subjectTarget
          Resource subjectTarget
          The actual object that is the target of the reference (The individual or set of individuals the action is being or was performed on.)
        • supportingInformation
          List<Reference> supportingInformation
          Further information supporting this charge.
        • supportingInformationTarget
          List<Resource> supportingInformationTarget
          The actual objects that are the target of the reference (Further information supporting this charge.)
    • Class org.hl7.fhir.r4.model.ChargeItem.ChargeItemPerformerComponent

      class ChargeItemPerformerComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1424001049L
      • Serialized Fields

        • actor
          Reference actor
          The device, practitioner, etc. who performed or participated in the service.
        • actorTarget
          Resource actorTarget
          The actual object that is the target of the reference (The device, practitioner, etc. who performed or participated in the service.)
        • function
          CodeableConcept function
          Describes the type of performance or participation(e.g. primary surgeon, anesthesiologiest, etc.).
    • Class org.hl7.fhir.r4.model.ChargeItem.ChargeItemStatusEnumFactory

      class ChargeItemStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.ChargeItemDefinition

      class ChargeItemDefinition extends MetadataResource implements Serializable
      serialVersionUID:
      -583681330L
      • Serialized Fields

        • applicability
          List<ChargeItemDefinition.ChargeItemDefinitionApplicabilityComponent> applicability
          Expressions that describe applicability criteria for the billing code.
        • approvalDate
          DateType approvalDate
          The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
        • code
          CodeableConcept code
          The defined billing details in this resource pertain to the given billing code.
        • copyright
          MarkdownType copyright
          A copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition.
        • derivedFromUri
          List<UriType> derivedFromUri
          The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.
        • effectivePeriod
          Period effectivePeriod
          The period during which the charge item definition content was or is planned to be in active use.
        • identifier
          List<Identifier> identifier
          A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
        • instance
          List<Reference> instance
          The defined billing details in this resource pertain to the given product instance(s).
        • instanceTarget
          List<Resource> instanceTarget
          The actual objects that are the target of the reference (The defined billing details in this resource pertain to the given product instance(s).)
        • lastReviewDate
          DateType lastReviewDate
          The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
        • partOf
          List<CanonicalType> partOf
          A larger definition of which this particular definition is a component or step.
        • propertyGroup
          List<ChargeItemDefinition.ChargeItemDefinitionPropertyGroupComponent> propertyGroup
          Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.
        • replaces
          List<CanonicalType> replaces
          As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.
    • Class org.hl7.fhir.r4.model.ChargeItemDefinition.ChargeItemDefinitionApplicabilityComponent

      class ChargeItemDefinitionApplicabilityComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1354288281L
      • Serialized Fields

        • description
          StringType description
          A brief, natural language description of the condition that effectively communicates the intended semantics.
        • expression
          StringType expression
          An expression that returns true or false, indicating whether the condition is satisfied. When using FHIRPath expressions, the %context environment variable must be replaced at runtime with the ChargeItem resource to which this definition is applied.
        • language
          StringType language
          The media type of the language for the expression, e.g. "text/cql" for Clinical Query Language expressions or "text/fhirpath" for FHIRPath expressions.
    • Class org.hl7.fhir.r4.model.ChargeItemDefinition.ChargeItemDefinitionPriceComponentTypeEnumFactory

      class ChargeItemDefinitionPriceComponentTypeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.ChargeItemDefinition.ChargeItemDefinitionPropertyGroupComponent

      class ChargeItemDefinitionPropertyGroupComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1723436176L
    • Class org.hl7.fhir.r4.model.ChargeItemDefinition.ChargeItemDefinitionPropertyGroupPriceComponentComponent

      class ChargeItemDefinitionPropertyGroupPriceComponentComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -841451335L
    • Class org.hl7.fhir.r4.model.Claim

      class Claim extends DomainResource implements Serializable
      serialVersionUID:
      -80376108L
      • Serialized Fields

        • accident
          Claim.AccidentComponent accident
          Details of an accident which resulted in injuries which required the products and services listed in the claim.
        • billablePeriod
          Period billablePeriod
          The period for which charges are being submitted.
        • careTeam
          List<Claim.CareTeamComponent> careTeam
          The members of the team who provided the products and services.
        • created
          DateTimeType created
          The date this resource was created.
        • diagnosis
          List<Claim.DiagnosisComponent> diagnosis
          Information about diagnoses relevant to the claim items.
        • enterer
          Reference enterer
          Individual who created the claim, predetermination or preauthorization.
        • entererTarget
          Resource entererTarget
          The actual object that is the target of the reference (Individual who created the claim, predetermination or preauthorization.)
        • facility
          Reference facility
          Facility where the services were provided.
        • facilityTarget
          Location facilityTarget
          The actual object that is the target of the reference (Facility where the services were provided.)
        • fundsReserve
          CodeableConcept fundsReserve
          A code to indicate whether and for whom funds are to be reserved for future claims.
        • identifier
          List<Identifier> identifier
          A unique identifier assigned to this claim.
        • insurance
          List<Claim.InsuranceComponent> insurance
          Financial instruments for reimbursement for the health care products and services specified on the claim.
        • insurer
          Reference insurer
          The Insurer who is target of the request.
        • insurerTarget
          Organization insurerTarget
          The actual object that is the target of the reference (The Insurer who is target of the request.)
        • item
          List<Claim.ItemComponent> item
          A claim line. Either a simple product or service or a 'group' of details which can each be a simple items or groups of sub-details.
        • originalPrescription
          Reference originalPrescription
          Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.
        • originalPrescriptionTarget
          Resource originalPrescriptionTarget
          The actual object that is the target of the reference (Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.)
        • patient
          Reference patient
          The party to whom the professional services and/or products have been supplied or are being considered and for whom actual or forecast reimbursement is sought.
        • patientTarget
          Patient patientTarget
          The actual object that is the target of the reference (The party to whom the professional services and/or products have been supplied or are being considered and for whom actual or forecast reimbursement is sought.)
        • payee
          Claim.PayeeComponent payee
          The party to be reimbursed for cost of the products and services according to the terms of the policy.
        • prescription
          Reference prescription
          Prescription to support the dispensing of pharmacy, device or vision products.
        • prescriptionTarget
          Resource prescriptionTarget
          The actual object that is the target of the reference (Prescription to support the dispensing of pharmacy, device or vision products.)
        • priority
          CodeableConcept priority
          The provider-required urgency of processing the request. Typical values include: stat, routine deferred.
        • procedure
          List<Claim.ProcedureComponent> procedure
          Procedures performed on the patient relevant to the billing items with the claim.
        • provider
          Reference provider
          The provider which is responsible for the claim, predetermination or preauthorization.
        • providerTarget
          Resource providerTarget
          The actual object that is the target of the reference (The provider which is responsible for the claim, predetermination or preauthorization.)
        • referral
          Reference referral
          A reference to a referral resource.
        • referralTarget
          ServiceRequest referralTarget
          The actual object that is the target of the reference (A reference to a referral resource.)
        • related
          List<Claim.RelatedClaimComponent> related
          Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.
        • status
          Enumeration<Claim.ClaimStatus> status
          The status of the resource instance.
        • subType
          CodeableConcept subType
          A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.
        • supportingInfo
          List<Claim.SupportingInformationComponent> supportingInfo
          Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.
        • total
          Money total
          The total value of the all the items in the claim.
        • type
          CodeableConcept type
          The category of claim, e.g. oral, pharmacy, vision, institutional, professional.
        • use
          Enumeration<Claim.Use> use
          A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.
    • Class org.hl7.fhir.r4.model.Claim.AccidentComponent

      class AccidentComponent extends BackboneElement implements Serializable
      serialVersionUID:
      622904984L
      • Serialized Fields

        • date
          DateType date
          Date of an accident event related to the products and services contained in the claim.
        • location
          Type location
          The physical location of the accident event.
        • type
          CodeableConcept type
          The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers.
    • Class org.hl7.fhir.r4.model.Claim.CareTeamComponent

      class CareTeamComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1758966968L
      • Serialized Fields

        • provider
          Reference provider
          Member of the team who provided the product or service.
        • providerTarget
          Resource providerTarget
          The actual object that is the target of the reference (Member of the team who provided the product or service.)
        • qualification
          CodeableConcept qualification
          The qualification of the practitioner which is applicable for this service.
        • responsible
          BooleanType responsible
          The party who is billing and/or responsible for the claimed products or services.
        • role
          CodeableConcept role
          The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team.
        • sequence
          PositiveIntType sequence
          A number to uniquely identify care team entries.
    • Class org.hl7.fhir.r4.model.Claim.ClaimStatusEnumFactory

      class ClaimStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Claim.DetailComponent

      class DetailComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1245004924L
      • Serialized Fields

        • category
          CodeableConcept category
          Code to identify the general type of benefits under which products and services are provided.
        • factor
          DecimalType factor
          A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
        • modifier
          List<CodeableConcept> modifier
          Item typification or modifiers codes to convey additional context for the product or service.
        • net
          Money net
          The quantity times the unit price for an additional service or product or charge.
        • productOrService
          CodeableConcept productOrService
          When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.
        • programCode
          List<CodeableConcept> programCode
          Identifies the program under which this may be recovered.
        • quantity
          Quantity quantity
          The number of repetitions of a service or product.
        • revenue
          CodeableConcept revenue
          The type of revenue or cost center providing the product and/or service.
        • sequence
          PositiveIntType sequence
          A number to uniquely identify item entries.
        • subDetail
          List<Claim.SubDetailComponent> subDetail
          A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.
        • udi
          List<Reference> udi
          Unique Device Identifiers associated with this line item.
        • udiTarget
          List<Device> udiTarget
          The actual objects that are the target of the reference (Unique Device Identifiers associated with this line item.)
        • unitPrice
          Money unitPrice
          If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
    • Class org.hl7.fhir.r4.model.Claim.DiagnosisComponent

      class DiagnosisComponent extends BackboneElement implements Serializable
      serialVersionUID:
      2120593974L
      • Serialized Fields

        • diagnosis
          Type diagnosis
          The nature of illness or problem in a coded form or as a reference to an external defined Condition.
        • onAdmission
          CodeableConcept onAdmission
          Indication of whether the diagnosis was present on admission to a facility.
        • packageCode
          CodeableConcept packageCode
          A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.
        • sequence
          PositiveIntType sequence
          A number to uniquely identify diagnosis entries.
        • type
          List<CodeableConcept> type
          When the condition was observed or the relative ranking.
    • Class org.hl7.fhir.r4.model.Claim.InsuranceComponent

      class InsuranceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1711744215L
      • Serialized Fields

        • businessArrangement
          StringType businessArrangement
          A business agreement number established between the provider and the insurer for special business processing purposes.
        • claimResponse
          Reference claimResponse
          The result of the adjudication of the line items for the Coverage specified in this insurance.
        • claimResponseTarget
          ClaimResponse claimResponseTarget
          The actual object that is the target of the reference (The result of the adjudication of the line items for the Coverage specified in this insurance.)
        • coverage
          Reference coverage
          Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.
        • coverageTarget
          Coverage coverageTarget
          The actual object that is the target of the reference (Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.)
        • focal
          BooleanType focal
          A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.
        • identifier
          Identifier identifier
          The business identifier to be used when the claim is sent for adjudication against this insurance policy.
        • preAuthRef
          List<StringType> preAuthRef
          Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization.
        • sequence
          PositiveIntType sequence
          A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.
    • Class org.hl7.fhir.r4.model.Claim.ItemComponent

      class ItemComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -329028323L
      • Serialized Fields

        • bodySite
          CodeableConcept bodySite
          Physical service site on the patient (limb, tooth, etc.).
        • careTeamSequence
          List<PositiveIntType> careTeamSequence
          CareTeam members related to this service or product.
        • category
          CodeableConcept category
          Code to identify the general type of benefits under which products and services are provided.
        • detail
          List<Claim.DetailComponent> detail
          A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.
        • diagnosisSequence
          List<PositiveIntType> diagnosisSequence
          Diagnosis applicable for this service or product.
        • encounter
          List<Reference> encounter
          The Encounters during which this Claim was created or to which the creation of this record is tightly associated.
        • encounterTarget
          List<Encounter> encounterTarget
          The actual objects that are the target of the reference (The Encounters during which this Claim was created or to which the creation of this record is tightly associated.)
        • factor
          DecimalType factor
          A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
        • informationSequence
          List<PositiveIntType> informationSequence
          Exceptions, special conditions and supporting information applicable for this service or product.
        • location
          Type location
          Where the product or service was provided.
        • modifier
          List<CodeableConcept> modifier
          Item typification or modifiers codes to convey additional context for the product or service.
        • net
          Money net
          The quantity times the unit price for an additional service or product or charge.
        • procedureSequence
          List<PositiveIntType> procedureSequence
          Procedures applicable for this service or product.
        • productOrService
          CodeableConcept productOrService
          When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.
        • programCode
          List<CodeableConcept> programCode
          Identifies the program under which this may be recovered.
        • quantity
          Quantity quantity
          The number of repetitions of a service or product.
        • revenue
          CodeableConcept revenue
          The type of revenue or cost center providing the product and/or service.
        • sequence
          PositiveIntType sequence
          A number to uniquely identify item entries.
        • serviced
          Type serviced
          The date or dates when the service or product was supplied, performed or completed.
        • subSite
          List<CodeableConcept> subSite
          A region or surface of the bodySite, e.g. limb region or tooth surface(s).
        • udi
          List<Reference> udi
          Unique Device Identifiers associated with this line item.
        • udiTarget
          List<Device> udiTarget
          The actual objects that are the target of the reference (Unique Device Identifiers associated with this line item.)
        • unitPrice
          Money unitPrice
          If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
    • Class org.hl7.fhir.r4.model.Claim.PayeeComponent

      class PayeeComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1609484699L
      • Serialized Fields

        • party
          Reference party
          Reference to the individual or organization to whom any payment will be made.
        • partyTarget
          Resource partyTarget
          The actual object that is the target of the reference (Reference to the individual or organization to whom any payment will be made.)
        • type
          CodeableConcept type
          Type of Party to be reimbursed: subscriber, provider, other.
    • Class org.hl7.fhir.r4.model.Claim.ProcedureComponent

      class ProcedureComponent extends BackboneElement implements Serializable
      serialVersionUID:
      935341852L
      • Serialized Fields

        • date
          DateTimeType date
          Date and optionally time the procedure was performed.
        • procedure
          Type procedure
          The code or reference to a Procedure resource which identifies the clinical intervention performed.
        • sequence
          PositiveIntType sequence
          A number to uniquely identify procedure entries.
        • type
          List<CodeableConcept> type
          When the condition was observed or the relative ranking.
        • udi
          List<Reference> udi
          Unique Device Identifiers associated with this line item.
        • udiTarget
          List<Device> udiTarget
          The actual objects that are the target of the reference (Unique Device Identifiers associated with this line item.)
    • Class org.hl7.fhir.r4.model.Claim.RelatedClaimComponent

      class RelatedClaimComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -379338905L
      • Serialized Fields

        • claim
          Reference claim
          Reference to a related claim.
        • claimTarget
          Claim claimTarget
          The actual object that is the target of the reference (Reference to a related claim.)
        • reference
          Identifier reference
          An alternate organizational reference to the case or file to which this particular claim pertains.
        • relationship
          CodeableConcept relationship
          A code to convey how the claims are related.
    • Class org.hl7.fhir.r4.model.Claim.SubDetailComponent

      class SubDetailComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1133026301L
      • Serialized Fields

        • category
          CodeableConcept category
          Code to identify the general type of benefits under which products and services are provided.
        • factor
          DecimalType factor
          A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
        • modifier
          List<CodeableConcept> modifier
          Item typification or modifiers codes to convey additional context for the product or service.
        • net
          Money net
          The quantity times the unit price for an additional service or product or charge.
        • productOrService
          CodeableConcept productOrService
          When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.
        • programCode
          List<CodeableConcept> programCode
          Identifies the program under which this may be recovered.
        • quantity
          Quantity quantity
          The number of repetitions of a service or product.
        • revenue
          CodeableConcept revenue
          The type of revenue or cost center providing the product and/or service.
        • sequence
          PositiveIntType sequence
          A number to uniquely identify item entries.
        • udi
          List<Reference> udi
          Unique Device Identifiers associated with this line item.
        • udiTarget
          List<Device> udiTarget
          The actual objects that are the target of the reference (Unique Device Identifiers associated with this line item.)
        • unitPrice
          Money unitPrice
          If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
    • Class org.hl7.fhir.r4.model.Claim.SupportingInformationComponent

      class SupportingInformationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -518630232L
      • Serialized Fields

        • category
          CodeableConcept category
          The general class of the information supplied: information; exception; accident, employment; onset, etc.
        • code
          CodeableConcept code
          System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.
        • reason
          CodeableConcept reason
          Provides the reason in the situation where a reason code is required in addition to the content.
        • sequence
          PositiveIntType sequence
          A number to uniquely identify supporting information entries.
        • timing
          Type timing
          The date when or period to which this information refers.
        • value
          Type value
          Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
    • Class org.hl7.fhir.r4.model.Claim.UseEnumFactory

      class UseEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.ClaimResponse

      class ClaimResponse extends DomainResource implements Serializable
      serialVersionUID:
      731586651L
      • Serialized Fields

        • addItem
          List<ClaimResponse.AddedItemComponent> addItem
          The first-tier service adjudications for payor added product or service lines.
        • adjudication
          List<ClaimResponse.AdjudicationComponent> adjudication
          The adjudication results which are presented at the header level rather than at the line-item or add-item levels.
        • communicationRequest
          List<Reference> communicationRequest
          Request for additional supporting or authorizing information.
        • communicationRequestTarget
          List<CommunicationRequest> communicationRequestTarget
          The actual objects that are the target of the reference (Request for additional supporting or authorizing information.)
        • created
          DateTimeType created
          The date this resource was created.
        • disposition
          StringType disposition
          A human readable description of the status of the adjudication.
        • error
          List<ClaimResponse.ErrorComponent> error
          Errors encountered during the processing of the adjudication.
        • form
          Attachment form
          The actual form, by reference or inclusion, for printing the content or an EOB.
        • formCode
          CodeableConcept formCode
          A code for the form to be used for printing the content.
        • fundsReserve
          CodeableConcept fundsReserve
          A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.
        • identifier
          List<Identifier> identifier
          A unique identifier assigned to this claim response.
        • insurance
          List<ClaimResponse.InsuranceComponent> insurance
          Financial instruments for reimbursement for the health care products and services specified on the claim.
        • insurer
          Reference insurer
          The party responsible for authorization, adjudication and reimbursement.
        • insurerTarget
          Organization insurerTarget
          The actual object that is the target of the reference (The party responsible for authorization, adjudication and reimbursement.)
        • item
          List<ClaimResponse.ItemComponent> item
          A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.
        • outcome
          Enumeration<ClaimResponse.RemittanceOutcome> outcome
          The outcome of the claim, predetermination, or preauthorization processing.
        • patient
          Reference patient
          The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought.
        • patientTarget
          Patient patientTarget
          The actual object that is the target of the reference (The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought.)
        • payeeType
          CodeableConcept payeeType
          Type of Party to be reimbursed: subscriber, provider, other.
        • payment
          ClaimResponse.PaymentComponent payment
          Payment details for the adjudication of the claim.
        • preAuthPeriod
          Period preAuthPeriod
          The time frame during which this authorization is effective.
        • preAuthRef
          StringType preAuthRef
          Reference from the Insurer which is used in later communications which refers to this adjudication.
        • processNote
          List<ClaimResponse.NoteComponent> processNote
          A note that describes or explains adjudication results in a human readable form.
        • request
          Reference request
          Original request resource reference.
        • requestor
          Reference requestor
          The provider which is responsible for the claim, predetermination or preauthorization.
        • requestorTarget
          Resource requestorTarget
          The actual object that is the target of the reference (The provider which is responsible for the claim, predetermination or preauthorization.)
        • requestTarget
          Claim requestTarget
          The actual object that is the target of the reference (Original request resource reference.)
        • status
          Enumeration<ClaimResponse.ClaimResponseStatus> status
          The status of the resource instance.
        • subType
          CodeableConcept subType
          A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.
        • total
          List<ClaimResponse.TotalComponent> total
          Categorized monetary totals for the adjudication.
        • type
          CodeableConcept type
          A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.
        • use
          Enumeration<ClaimResponse.Use> use
          A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.
    • Class org.hl7.fhir.r4.model.ClaimResponse.AddedItemComponent

      class AddedItemComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1193747282L
      • Serialized Fields

        • adjudication
          List<ClaimResponse.AdjudicationComponent> adjudication
          The adjudication results.
        • bodySite
          CodeableConcept bodySite
          Physical service site on the patient (limb, tooth, etc.).
        • detail
          List<ClaimResponse.AddedItemDetailComponent> detail
          The second-tier service adjudications for payor added services.
        • detailSequence
          List<PositiveIntType> detailSequence
          The sequence number of the details within the claim item which this line is intended to replace.
        • factor
          DecimalType factor
          A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
        • itemSequence
          List<PositiveIntType> itemSequence
          Claim items which this service line is intended to replace.
        • location
          Type location
          Where the product or service was provided.
        • modifier
          List<CodeableConcept> modifier
          Item typification or modifiers codes to convey additional context for the product or service.
        • net
          Money net
          The quantity times the unit price for an additional service or product or charge.
        • noteNumber
          List<PositiveIntType> noteNumber
          The numbers associated with notes below which apply to the adjudication of this item.
        • productOrService
          CodeableConcept productOrService
          When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.
        • programCode
          List<CodeableConcept> programCode
          Identifies the program under which this may be recovered.
        • provider
          List<Reference> provider
          The providers who are authorized for the services rendered to the patient.
        • providerTarget
          List<Resource> providerTarget
          The actual objects that are the target of the reference (The providers who are authorized for the services rendered to the patient.)
        • quantity
          Quantity quantity
          The number of repetitions of a service or product.
        • serviced
          Type serviced
          The date or dates when the service or product was supplied, performed or completed.
        • subdetailSequence
          List<PositiveIntType> subdetailSequence
          The sequence number of the sub-details within the details within the claim item which this line is intended to replace.
        • subSite
          List<CodeableConcept> subSite
          A region or surface of the bodySite, e.g. limb region or tooth surface(s).
        • unitPrice
          Money unitPrice
          If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
    • Class org.hl7.fhir.r4.model.ClaimResponse.AddedItemDetailComponent

      class AddedItemDetailComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1436724060L
      • Serialized Fields

        • adjudication
          List<ClaimResponse.AdjudicationComponent> adjudication
          The adjudication results.
        • factor
          DecimalType factor
          A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
        • modifier
          List<CodeableConcept> modifier
          Item typification or modifiers codes to convey additional context for the product or service.
        • net
          Money net
          The quantity times the unit price for an additional service or product or charge.
        • noteNumber
          List<PositiveIntType> noteNumber
          The numbers associated with notes below which apply to the adjudication of this item.
        • productOrService
          CodeableConcept productOrService
          When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.
        • quantity
          Quantity quantity
          The number of repetitions of a service or product.
        • subDetail
          List<ClaimResponse.AddedItemSubDetailComponent> subDetail
          The third-tier service adjudications for payor added services.
        • unitPrice
          Money unitPrice
          If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
    • Class org.hl7.fhir.r4.model.ClaimResponse.AddedItemSubDetailComponent

      class AddedItemSubDetailComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1301363592L
      • Serialized Fields

        • adjudication
          List<ClaimResponse.AdjudicationComponent> adjudication
          The adjudication results.
        • factor
          DecimalType factor
          A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
        • modifier
          List<CodeableConcept> modifier
          Item typification or modifiers codes to convey additional context for the product or service.
        • net
          Money net
          The quantity times the unit price for an additional service or product or charge.
        • noteNumber
          List<PositiveIntType> noteNumber
          The numbers associated with notes below which apply to the adjudication of this item.
        • productOrService
          CodeableConcept productOrService
          When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.
        • quantity
          Quantity quantity
          The number of repetitions of a service or product.
        • unitPrice
          Money unitPrice
          If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
    • Class org.hl7.fhir.r4.model.ClaimResponse.AdjudicationComponent

      class AdjudicationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1559898786L
      • Serialized Fields

        • amount
          Money amount
          Monetary amount associated with the category.
        • category
          CodeableConcept category
          A code to indicate the information type of this adjudication record. Information types may include the value submitted, maximum values or percentages allowed or payable under the plan, amounts that: the patient is responsible for in aggregate or pertaining to this item; amounts paid by other coverages; and, the benefit payable for this item.
        • reason
          CodeableConcept reason
          A code supporting the understanding of the adjudication result and explaining variance from expected amount.
        • value
          DecimalType value
          A non-monetary value associated with the category. Mutually exclusive to the amount element above.
    • Class org.hl7.fhir.r4.model.ClaimResponse.ClaimResponseStatusEnumFactory

      class ClaimResponseStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.ClaimResponse.ErrorComponent

      class ErrorComponent extends BackboneElement implements Serializable
      serialVersionUID:
      843818320L
      • Serialized Fields

        • code
          CodeableConcept code
          An error code, from a specified code system, which details why the claim could not be adjudicated.
        • detailSequence
          PositiveIntType detailSequence
          The sequence number of the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.
        • itemSequence
          PositiveIntType itemSequence
          The sequence number of the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.
        • subDetailSequence
          PositiveIntType subDetailSequence
          The sequence number of the sub-detail within the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.
    • Class org.hl7.fhir.r4.model.ClaimResponse.InsuranceComponent

      class InsuranceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      282380584L
      • Serialized Fields

        • businessArrangement
          StringType businessArrangement
          A business agreement number established between the provider and the insurer for special business processing purposes.
        • claimResponse
          Reference claimResponse
          The result of the adjudication of the line items for the Coverage specified in this insurance.
        • claimResponseTarget
          ClaimResponse claimResponseTarget
          The actual object that is the target of the reference (The result of the adjudication of the line items for the Coverage specified in this insurance.)
        • coverage
          Reference coverage
          Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.
        • coverageTarget
          Coverage coverageTarget
          The actual object that is the target of the reference (Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.)
        • focal
          BooleanType focal
          A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.
        • sequence
          PositiveIntType sequence
          A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.
    • Class org.hl7.fhir.r4.model.ClaimResponse.ItemComponent

      class ItemComponent extends BackboneElement implements Serializable
      serialVersionUID:
      701277928L
      • Serialized Fields

        • adjudication
          List<ClaimResponse.AdjudicationComponent> adjudication
          If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.
        • detail
          List<ClaimResponse.ItemDetailComponent> detail
          A claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items.
        • itemSequence
          PositiveIntType itemSequence
          A number to uniquely reference the claim item entries.
        • noteNumber
          List<PositiveIntType> noteNumber
          The numbers associated with notes below which apply to the adjudication of this item.
    • Class org.hl7.fhir.r4.model.ClaimResponse.ItemDetailComponent

      class ItemDetailComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1066636111L
    • Class org.hl7.fhir.r4.model.ClaimResponse.NoteComponent

      class NoteComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -385184277L
    • Class org.hl7.fhir.r4.model.ClaimResponse.PaymentComponent

      class PaymentComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1539906026L
      • Serialized Fields

        • adjustment
          Money adjustment
          Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication.
        • adjustmentReason
          CodeableConcept adjustmentReason
          Reason for the payment adjustment.
        • amount
          Money amount
          Benefits payable less any payment adjustment.
        • date
          DateType date
          Estimated date the payment will be issued or the actual issue date of payment.
        • identifier
          Identifier identifier
          Issuer's unique identifier for the payment instrument.
        • type
          CodeableConcept type
          Whether this represents partial or complete payment of the benefits payable.
    • Class org.hl7.fhir.r4.model.ClaimResponse.RemittanceOutcomeEnumFactory

      class RemittanceOutcomeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.ClaimResponse.SubDetailComponent

      class SubDetailComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1083724362L
    • Class org.hl7.fhir.r4.model.ClaimResponse.TotalComponent

      class TotalComponent extends BackboneElement implements Serializable
      serialVersionUID:
      2012310309L
      • Serialized Fields

        • amount
          Money amount
          Monetary total amount associated with the category.
        • category
          CodeableConcept category
          A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.
    • Class org.hl7.fhir.r4.model.ClaimResponse.UseEnumFactory

      class UseEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.ClinicalImpression

      class ClinicalImpression extends DomainResource implements Serializable
      serialVersionUID:
      1158874575L
      • Serialized Fields

        • assessor
          Reference assessor
          The clinician performing the assessment.
        • assessorTarget
          Resource assessorTarget
          The actual object that is the target of the reference (The clinician performing the assessment.)
        • code
          CodeableConcept code
          Categorizes the type of clinical assessment performed.
        • date
          DateTimeType date
          Indicates when the documentation of the assessment was complete.
        • description
          StringType description
          A summary of the context and/or cause of the assessment - why / where it was performed, and what patient events/status prompted it.
        • effective
          Type effective
          The point in time or period over which the subject was assessed.
        • encounter
          Reference encounter
          The Encounter during which this ClinicalImpression was created or to which the creation of this record is tightly associated.
        • encounterTarget
          Encounter encounterTarget
          The actual object that is the target of the reference (The Encounter during which this ClinicalImpression was created or to which the creation of this record is tightly associated.)
        • finding
          List<ClinicalImpression.ClinicalImpressionFindingComponent> finding
          Specific findings or diagnoses that were considered likely or relevant to ongoing treatment.
        • identifier
          List<Identifier> identifier
          Business identifiers assigned to this clinical impression by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
        • investigation
          List<ClinicalImpression.ClinicalImpressionInvestigationComponent> investigation
          One or more sets of investigations (signs, symptoms, etc.). The actual grouping of investigations varies greatly depending on the type and context of the assessment. These investigations may include data generated during the assessment process, or data previously generated and recorded that is pertinent to the outcomes.
        • note
          List<Annotation> note
          Commentary about the impression, typically recorded after the impression itself was made, though supplemental notes by the original author could also appear.
        • previous
          Reference previous
          A reference to the last assessment that was conducted on this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes.
        • previousTarget
          ClinicalImpression previousTarget
          The actual object that is the target of the reference (A reference to the last assessment that was conducted on this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes.)
        • problem
          List<Reference> problem
          A list of the relevant problems/conditions for a patient.
        • problemTarget
          List<Resource> problemTarget
          The actual objects that are the target of the reference (A list of the relevant problems/conditions for a patient.)
        • prognosisCodeableConcept
          List<CodeableConcept> prognosisCodeableConcept
          Estimate of likely outcome.
        • prognosisReference
          List<Reference> prognosisReference
          RiskAssessment expressing likely outcome.
        • prognosisReferenceTarget
          List<RiskAssessment> prognosisReferenceTarget
          The actual objects that are the target of the reference (RiskAssessment expressing likely outcome.)
        • protocol
          List<UriType> protocol
          Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis.
        • status
          Enumeration<ClinicalImpression.ClinicalImpressionStatus> status
          Identifies the workflow status of the assessment.
        • statusReason
          CodeableConcept statusReason
          Captures the reason for the current state of the ClinicalImpression.
        • subject
          Reference subject
          The patient or group of individuals assessed as part of this record.
        • subjectTarget
          Resource subjectTarget
          The actual object that is the target of the reference (The patient or group of individuals assessed as part of this record.)
        • summary
          StringType summary
          A text summary of the investigations and the diagnosis.
        • supportingInfo
          List<Reference> supportingInfo
          Information supporting the clinical impression.
        • supportingInfoTarget
          List<Resource> supportingInfoTarget
          The actual objects that are the target of the reference (Information supporting the clinical impression.)
    • Class org.hl7.fhir.r4.model.ClinicalImpression.ClinicalImpressionFindingComponent

      class ClinicalImpressionFindingComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1578446448L
      • Serialized Fields

        • basis
          StringType basis
          Which investigations support finding or diagnosis.
        • itemCodeableConcept
          CodeableConcept itemCodeableConcept
          Specific text or code for finding or diagnosis, which may include ruled-out or resolved conditions.
        • itemReference
          Reference itemReference
          Specific reference for finding or diagnosis, which may include ruled-out or resolved conditions.
        • itemReferenceTarget
          Resource itemReferenceTarget
          The actual object that is the target of the reference (Specific reference for finding or diagnosis, which may include ruled-out or resolved conditions.)
    • Class org.hl7.fhir.r4.model.ClinicalImpression.ClinicalImpressionInvestigationComponent

      class ClinicalImpressionInvestigationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -301363326L
      • Serialized Fields

        • code
          CodeableConcept code
          A name/code for the group ("set") of investigations. Typically, this will be something like "signs", "symptoms", "clinical", "diagnostic", but the list is not constrained, and others such groups such as (exposure|family|travel|nutritional) history may be used.
        • item
          List<Reference> item
          A record of a specific investigation that was undertaken.
        • itemTarget
          List<Resource> itemTarget
          The actual objects that are the target of the reference (A record of a specific investigation that was undertaken.)
    • Class org.hl7.fhir.r4.model.ClinicalImpression.ClinicalImpressionStatusEnumFactory

      class ClinicalImpressionStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CodeableConcept

      class CodeableConcept extends Type implements Serializable
      serialVersionUID:
      760353246L
      • Serialized Fields

        • coding
          List<Coding> coding
          A reference to a code defined by a terminology system.
        • text
          StringType text
          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
    • Class org.hl7.fhir.r4.model.CodeSystem

      class CodeSystem extends MetadataResource implements Serializable
      serialVersionUID:
      -1735124584L
      • Serialized Fields

        • caseSensitive
          BooleanType caseSensitive
          If code comparison is case sensitive when codes within this system are compared to each other.
        • compositional
          BooleanType compositional
          The code system defines a compositional (post-coordination) grammar.
        • concept
          List<CodeSystem.ConceptDefinitionComponent> concept
          Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are.
        • content
          Enumeration<CodeSystem.CodeSystemContentMode> content
          The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.
        • copyright
          MarkdownType copyright
          A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.
        • count
          UnsignedIntType count
          The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward.
        • filter
          List<CodeSystem.CodeSystemFilterComponent> filter
          A filter that can be used in a value set compose statement when selecting concepts using a filter.
        • hierarchyMeaning
          Enumeration<CodeSystem.CodeSystemHierarchyMeaning> hierarchyMeaning
          The meaning of the hierarchy of concepts as represented in this resource.
        • identifier
          List<Identifier> identifier
          A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.
        • property
          List<CodeSystem.PropertyComponent> property
          A property defines an additional slot through which additional information can be provided about a concept.
        • purpose
          MarkdownType purpose
          Explanation of why this code system is needed and why it has been designed as it has.
        • supplements
          CanonicalType supplements
          The canonical URL of the code system that this code system supplement is adding designations and properties to.
        • valueSet
          CanonicalType valueSet
          Canonical reference to the value set that contains the entire code system.
        • versionNeeded
          BooleanType versionNeeded
          This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system.
    • Class org.hl7.fhir.r4.model.CodeSystem.CodeSystemContentModeEnumFactory

      class CodeSystemContentModeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CodeSystem.CodeSystemFilterComponent

      class CodeSystemFilterComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1087409836L
      • Serialized Fields

        • code
          CodeType code
          The code that identifies this filter when it is used as a filter in [[[ValueSet]]].compose.include.filter.
        • description
          StringType description
          A description of how or why the filter is used.
        • operator
          List<Enumeration<CodeSystem.FilterOperator>> operator
          A list of operators that can be used with the filter.
        • value
          StringType value
          A description of what the value for the filter should be.
    • Class org.hl7.fhir.r4.model.CodeSystem.CodeSystemHierarchyMeaningEnumFactory

      class CodeSystemHierarchyMeaningEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CodeSystem.ConceptDefinitionComponent

      class ConceptDefinitionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      878320988L
      • Serialized Fields

        • code
          CodeType code
          A code - a text symbol - that uniquely identifies the concept within the code system.
        • concept
          List<CodeSystem.ConceptDefinitionComponent> concept
          Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) - see hierarchyMeaning.
        • definition
          StringType definition
          The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.
        • designation
          List<CodeSystem.ConceptDefinitionDesignationComponent> designation
          Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.
        • display
          StringType display
          A human readable string that is the recommended default way to present this concept to a user.
        • property
          List<CodeSystem.ConceptPropertyComponent> property
          A property value for this concept.
    • Class org.hl7.fhir.r4.model.CodeSystem.ConceptDefinitionDesignationComponent

      class ConceptDefinitionDesignationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1515662414L
      • Serialized Fields

        • language
          CodeType language
          The language this designation is defined for.
        • use
          Coding use
          A code that details how this designation would be used.
        • value
          StringType value
          The text value for this designation.
    • Class org.hl7.fhir.r4.model.CodeSystem.ConceptPropertyComponent

      class ConceptPropertyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1742812311L
      • Serialized Fields

        • code
          CodeType code
          A code that is a reference to CodeSystem.property.code.
        • value
          Type value
          The value of this property.
    • Class org.hl7.fhir.r4.model.CodeSystem.FilterOperatorEnumFactory

      class FilterOperatorEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CodeSystem.PropertyComponent

      class PropertyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1810713373L
      • Serialized Fields

        • code
          CodeType code
          A code that is used to identify the property. The code is used internally (in CodeSystem.concept.property.code) and also externally, such as in property filters.
        • description
          StringType description
          A description of the property- why it is defined, and how its value might be used.
        • type
          Enumeration<CodeSystem.PropertyType> type
          The type of the property value. Properties of type "code" contain a code defined by the code system (e.g. a reference to another defined concept).
        • uri
          UriType uri
          Reference to the formal meaning of the property. One possible source of meaning is the [Concept Properties](codesystem-concept-properties.html) code system.
    • Class org.hl7.fhir.r4.model.CodeSystem.PropertyTypeEnumFactory

      class PropertyTypeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CodeType

      class CodeType extends StringType implements Externalizable
      serialVersionUID:
      3L
    • Class org.hl7.fhir.r4.model.Coding

      class Coding extends Type implements Serializable
      serialVersionUID:
      -1417514061L
      • Serialized Fields

        • code
          CodeType code
          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
        • display
          StringType display
          A representation of the meaning of the code in the system, following the rules of the system.
        • system
          UriType system
          The identification of the code system that defines the meaning of the symbol in the code.
        • userSelected
          BooleanType userSelected
          Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
        • version
          StringType version
          The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
    • Class org.hl7.fhir.r4.model.Communication

      class Communication extends DomainResource implements Serializable
      serialVersionUID:
      1325359310L
      • Serialized Fields

        • about
          List<Reference> about
          Other resources that pertain to this communication and to which this communication should be associated.
        • aboutTarget
          List<Resource> aboutTarget
          The actual objects that are the target of the reference (Other resources that pertain to this communication and to which this communication should be associated.)
        • basedOn
          List<Reference> basedOn
          An order, proposal or plan fulfilled in whole or in part by this Communication.
        • basedOnTarget
          List<Resource> basedOnTarget
          The actual objects that are the target of the reference (An order, proposal or plan fulfilled in whole or in part by this Communication.)
        • category
          List<CodeableConcept> category
          The type of message conveyed such as alert, notification, reminder, instruction, etc.
        • encounter
          Reference encounter
          The Encounter during which this Communication was created or to which the creation of this record is tightly associated.
        • encounterTarget
          Encounter encounterTarget
          The actual object that is the target of the reference (The Encounter during which this Communication was created or to which the creation of this record is tightly associated.)
        • identifier
          List<Identifier> identifier
          Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
        • inResponseTo
          List<Reference> inResponseTo
          Prior communication that this communication is in response to.
        • inResponseToTarget
          List<Communication> inResponseToTarget
          The actual objects that are the target of the reference (Prior communication that this communication is in response to.)
        • instantiatesCanonical
          List<CanonicalType> instantiatesCanonical
          The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
        • instantiatesUri
          List<UriType> instantiatesUri
          The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
        • medium
          List<CodeableConcept> medium
          A channel that was used for this communication (e.g. email, fax).
        • note
          List<Annotation> note
          Additional notes or commentary about the communication by the sender, receiver or other interested parties.
        • partOf
          List<Reference> partOf
          Part of this action.
        • partOfTarget
          List<Resource> partOfTarget
          The actual objects that are the target of the reference (Part of this action.)
        • payload
          List<Communication.CommunicationPayloadComponent> payload
          Text, attachment(s), or resource(s) that was communicated to the recipient.
        • priority
          Enumeration<Communication.CommunicationPriority> priority
          Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.
        • reasonCode
          List<CodeableConcept> reasonCode
          The reason or justification for the communication.
        • reasonReference
          List<Reference> reasonReference
          Indicates another resource whose existence justifies this communication.
        • reasonReferenceTarget
          List<Resource> reasonReferenceTarget
          The actual objects that are the target of the reference (Indicates another resource whose existence justifies this communication.)
        • received
          DateTimeType received
          The time when this communication arrived at the destination.
        • recipient
          List<Reference> recipient
          The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).
        • recipientTarget
          List<Resource> recipientTarget
          The actual objects that are the target of the reference (The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).)
        • sender
          Reference sender
          The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.
        • senderTarget
          Resource senderTarget
          The actual object that is the target of the reference (The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.)
        • sent
          DateTimeType sent
          The time when this communication was sent.
        • status
          Enumeration<Communication.CommunicationStatus> status
          The status of the transmission.
        • statusReason
          CodeableConcept statusReason
          Captures the reason for the current state of the Communication.
        • subject
          Reference subject
          The patient or group that was the focus of this communication.
        • subjectTarget
          Resource subjectTarget
          The actual object that is the target of the reference (The patient or group that was the focus of this communication.)
        • topic
          CodeableConcept topic
          Description of the purpose/content, similar to a subject line in an email.
    • Class org.hl7.fhir.r4.model.Communication.CommunicationPayloadComponent

      class CommunicationPayloadComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1763459053L
      • Serialized Fields

        • content
          Type content
          A communicated content (or for multi-part communications, one portion of the communication).
    • Class org.hl7.fhir.r4.model.Communication.CommunicationPriorityEnumFactory

      class CommunicationPriorityEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Communication.CommunicationStatusEnumFactory

      class CommunicationStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CommunicationRequest

      class CommunicationRequest extends DomainResource implements Serializable
      serialVersionUID:
      2131096857L
      • Serialized Fields

        • about
          List<Reference> about
          Other resources that pertain to this communication request and to which this communication request should be associated.
        • aboutTarget
          List<Resource> aboutTarget
          The actual objects that are the target of the reference (Other resources that pertain to this communication request and to which this communication request should be associated.)
        • authoredOn
          DateTimeType authoredOn
          For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
        • basedOn
          List<Reference> basedOn
          A plan or proposal that is fulfilled in whole or in part by this request.
        • basedOnTarget
          List<Resource> basedOnTarget
          The actual objects that are the target of the reference (A plan or proposal that is fulfilled in whole or in part by this request.)
        • category
          List<CodeableConcept> category
          The type of message to be sent such as alert, notification, reminder, instruction, etc.
        • doNotPerform
          BooleanType doNotPerform
          If true indicates that the CommunicationRequest is asking for the specified action to *not* occur.
        • encounter
          Reference encounter
          The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.
        • encounterTarget
          Encounter encounterTarget
          The actual object that is the target of the reference (The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.)
        • groupIdentifier
          Identifier groupIdentifier
          A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
        • identifier
          List<Identifier> identifier
          Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
        • medium
          List<CodeableConcept> medium
          A channel that was used for this communication (e.g. email, fax).
        • note
          List<Annotation> note
          Comments made about the request by the requester, sender, recipient, subject or other participants.
        • occurrence
          Type occurrence
          The time when this communication is to occur.
        • payload
          List<CommunicationRequest.CommunicationRequestPayloadComponent> payload
          Text, attachment(s), or resource(s) to be communicated to the recipient.
        • priority
          Enumeration<CommunicationRequest.CommunicationPriority> priority
          Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
        • reasonCode
          List<CodeableConcept> reasonCode
          Describes why the request is being made in coded or textual form.
        • reasonReference
          List<Reference> reasonReference
          Indicates another resource whose existence justifies this request.
        • reasonReferenceTarget
          List<Resource> reasonReferenceTarget
          The actual objects that are the target of the reference (Indicates another resource whose existence justifies this request.)
        • recipient
          List<Reference> recipient
          The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.
        • recipientTarget
          List<Resource> recipientTarget
          The actual objects that are the target of the reference (The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.)
        • replaces
          List<Reference> replaces
          Completed or terminated request(s) whose function is taken by this new request.
        • replacesTarget
          List<CommunicationRequest> replacesTarget
          The actual objects that are the target of the reference (Completed or terminated request(s) whose function is taken by this new request.)
        • requester
          Reference requester
          The device, individual, or organization who initiated the request and has responsibility for its activation.
        • requesterTarget
          Resource requesterTarget
          The actual object that is the target of the reference (The device, individual, or organization who initiated the request and has responsibility for its activation.)
        • sender
          Reference sender
          The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
        • senderTarget
          Resource senderTarget
          The actual object that is the target of the reference (The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.)
        • status
          Enumeration<CommunicationRequest.CommunicationRequestStatus> status
          The status of the proposal or order.
        • statusReason
          CodeableConcept statusReason
          Captures the reason for the current state of the CommunicationRequest.
        • subject
          Reference subject
          The patient or group that is the focus of this communication request.
        • subjectTarget
          Resource subjectTarget
          The actual object that is the target of the reference (The patient or group that is the focus of this communication request.)
    • Class org.hl7.fhir.r4.model.CommunicationRequest.CommunicationPriorityEnumFactory

      class CommunicationPriorityEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CommunicationRequest.CommunicationRequestPayloadComponent

      class CommunicationRequestPayloadComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1763459053L
      • Serialized Fields

        • content
          Type content
          The communicated content (or for multi-part communications, one portion of the communication).
    • Class org.hl7.fhir.r4.model.CommunicationRequest.CommunicationRequestStatusEnumFactory

      class CommunicationRequestStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CompartmentDefinition

      class CompartmentDefinition extends MetadataResource implements Serializable
      serialVersionUID:
      -1159172945L
    • Class org.hl7.fhir.r4.model.CompartmentDefinition.CompartmentDefinitionResourceComponent

      class CompartmentDefinitionResourceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      988080897L
      • Serialized Fields

        • code
          CodeType code
          The name of a resource supported by the server.
        • documentation
          StringType documentation
          Additional documentation about the resource and compartment.
        • param
          List<StringType> param
          The name of a search parameter that represents the link to the compartment. More than one may be listed because a resource may be linked to a compartment in more than one way,.
    • Class org.hl7.fhir.r4.model.CompartmentDefinition.CompartmentTypeEnumFactory

      class CompartmentTypeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Composition

      class Composition extends DomainResource implements Serializable
      serialVersionUID:
      -1490206663L
      • Serialized Fields

        • attester
          List<Composition.CompositionAttesterComponent> attester
          A participant who has attested to the accuracy of the composition/document.
        • author
          List<Reference> author
          Identifies who is responsible for the information in the composition, not necessarily who typed it in.
        • authorTarget
          List<Resource> authorTarget
          The actual objects that are the target of the reference (Identifies who is responsible for the information in the composition, not necessarily who typed it in.)
        • category
          List<CodeableConcept> category
          A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.
        • confidentiality
          Enumeration<Composition.DocumentConfidentiality> confidentiality
          The code specifying the level of confidentiality of the Composition.
        • custodian
          Reference custodian
          Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
        • custodianTarget
          Organization custodianTarget
          The actual object that is the target of the reference (Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.)
        • date
          DateTimeType date
          The composition editing time, when the composition was last logically changed by the author.
        • encounter
          Reference encounter
          Describes the clinical encounter or type of care this documentation is associated with.
        • encounterTarget
          Encounter encounterTarget
          The actual object that is the target of the reference (Describes the clinical encounter or type of care this documentation is associated with.)
        • event
          List<Composition.CompositionEventComponent> event
          The clinical service, such as a colonoscopy or an appendectomy, being documented.
        • identifier
          Identifier identifier
          A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.
        • relatesTo
          List<Composition.CompositionRelatesToComponent> relatesTo
          Relationships that this composition has with other compositions or documents that already exist.
        • section
          List<Composition.SectionComponent> section
          The root of the sections that make up the composition.
        • status
          Enumeration<Composition.CompositionStatus> status
          The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.
        • subject
          Reference subject
          Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).
        • subjectTarget
          Resource subjectTarget
          The actual object that is the target of the reference (Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).)
        • title
          StringType title
          Official human-readable label for the composition.
        • type
          CodeableConcept type
          Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.
    • Class org.hl7.fhir.r4.model.Composition.CompositionAttestationModeEnumFactory

      class CompositionAttestationModeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Composition.CompositionAttesterComponent

      class CompositionAttesterComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1917768205L
      • Serialized Fields

        • mode
          Enumeration<Composition.CompositionAttestationMode> mode
          The type of attestation the authenticator offers.
        • party
          Reference party
          Who attested the composition in the specified way.
        • partyTarget
          Resource partyTarget
          The actual object that is the target of the reference (Who attested the composition in the specified way.)
        • time
          DateTimeType time
          When the composition was attested by the party.
    • Class org.hl7.fhir.r4.model.Composition.CompositionEventComponent

      class CompositionEventComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1581379774L
      • Serialized Fields

        • code
          List<CodeableConcept> code
          This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.
        • detail
          List<Reference> detail
          The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.
        • detailTarget
          List<Resource> detailTarget
          The actual objects that are the target of the reference (The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.)
        • period
          Period period
          The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.
    • Class org.hl7.fhir.r4.model.Composition.CompositionRelatesToComponent

      class CompositionRelatesToComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1536930280L
    • Class org.hl7.fhir.r4.model.Composition.CompositionStatusEnumFactory

      class CompositionStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Composition.DocumentConfidentialityEnumFactory

      class DocumentConfidentialityEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Composition.DocumentRelationshipTypeEnumFactory

      class DocumentRelationshipTypeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Composition.SectionComponent

      class SectionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -797396954L
      • Serialized Fields

        • author
          List<Reference> author
          Identifies who is responsible for the information in this section, not necessarily who typed it in.
        • authorTarget
          List<Resource> authorTarget
          The actual objects that are the target of the reference (Identifies who is responsible for the information in this section, not necessarily who typed it in.)
        • code
          CodeableConcept code
          A code identifying the kind of content contained within the section. This must be consistent with the section title.
        • emptyReason
          CodeableConcept emptyReason
          If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
        • entry
          List<Reference> entry
          A reference to the actual resource from which the narrative in the section is derived.
        • entryTarget
          List<Resource> entryTarget
          The actual objects that are the target of the reference (A reference to the actual resource from which the narrative in the section is derived.)
        • focus
          Reference focus
          The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
        • focusTarget
          Resource focusTarget
          The actual object that is the target of the reference (The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).)
        • mode
          Enumeration<Composition.SectionMode> mode
          How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
        • orderedBy
          CodeableConcept orderedBy
          Specifies the order applied to the items in the section entries.
        • section
          List<Composition.SectionComponent> section
          A nested sub-section within this section.
        • text
          Narrative text
          A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
        • title
          StringType title
          The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
    • Class org.hl7.fhir.r4.model.Composition.SectionModeEnumFactory

      class SectionModeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.ConceptMap

      class ConceptMap extends MetadataResource implements Serializable
      serialVersionUID:
      -2081872580L
      • Serialized Fields

        • copyright
          MarkdownType copyright
          A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map.
        • group
          List<ConceptMap.ConceptMapGroupComponent> group
          A group of mappings that all have the same source and target system.
        • identifier
          Identifier identifier
          A formal identifier that is used to identify this concept map when it is represented in other formats, or referenced in a specification, model, design or an instance.
        • purpose
          MarkdownType purpose
          Explanation of why this concept map is needed and why it has been designed as it has.
        • source
          Type source
          Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings.
        • target
          Type target
          The target value set provides context for the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.
    • Class org.hl7.fhir.r4.model.ConceptMap.ConceptMapGroupComponent

      class ConceptMapGroupComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1606357508L
      • Serialized Fields

        • element
          List<ConceptMap.SourceElementComponent> element
          Mappings for an individual concept in the source to one or more concepts in the target.
        • source
          UriType source
          An absolute URI that identifies the source system where the concepts to be mapped are defined.
        • sourceVersion
          StringType sourceVersion
          The specific version of the code system, as determined by the code system authority.
        • target
          UriType target
          An absolute URI that identifies the target system that the concepts will be mapped to.
        • targetVersion
          StringType targetVersion
          The specific version of the code system, as determined by the code system authority.
        • unmapped
          ConceptMap.ConceptMapGroupUnmappedComponent unmapped
          What to do when there is no mapping for the source concept. "Unmapped" does not include codes that are unmatched, and the unmapped element is ignored in a code is specified to have equivalence = unmatched.
    • Class org.hl7.fhir.r4.model.ConceptMap.ConceptMapGroupUnmappedComponent

      class ConceptMapGroupUnmappedComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1261364354L
      • Serialized Fields

        • code
          CodeType code
          The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code.
        • display
          StringType display
          The display for the code. The display is only provided to help editors when editing the concept map.
        • mode
          Enumeration<ConceptMap.ConceptMapGroupUnmappedMode> mode
          Defines which action to take if there is no match for the source concept in the target system designated for the group. One of 3 actions are possible: use the unmapped code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL).
        • url
          CanonicalType url
          The canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source concept.
    • Class org.hl7.fhir.r4.model.ConceptMap.ConceptMapGroupUnmappedModeEnumFactory

      class ConceptMapGroupUnmappedModeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.ConceptMap.OtherElementComponent

      class OtherElementComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1836341923L
      • Serialized Fields

        • display
          StringType display
          The display for the code. The display is only provided to help editors when editing the concept map.
        • property
          UriType property
          A reference to an element that holds a coded value that corresponds to a code system property. The idea is that the information model carries an element somewhere that is labeled to correspond with a code system property.
        • system
          CanonicalType system
          An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that crosses code systems).
        • value
          StringType value
          Identity (code or path) or the element/item/ValueSet/text that the map depends on / refers to.
    • Class org.hl7.fhir.r4.model.ConceptMap.SourceElementComponent

      class SourceElementComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1115258852L
      • Serialized Fields

        • code
          CodeType code
          Identity (code or path) or the element/item being mapped.
        • display
          StringType display
          The display for the code. The display is only provided to help editors when editing the concept map.
        • target
          List<ConceptMap.TargetElementComponent> target
          A concept from the target value set that this concept maps to.
    • Class org.hl7.fhir.r4.model.ConceptMap.TargetElementComponent

      class TargetElementComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -2008997477L
      • Serialized Fields

        • code
          CodeType code
          Identity (code or path) or the element/item that the map refers to.
        • comment
          StringType comment
          A description of status/issues in mapping that conveys additional information not represented in the structured data.
        • dependsOn
          List<ConceptMap.OtherElementComponent> dependsOn
          A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element can be resolved, and it has the specified value.
        • display
          StringType display
          The display for the code. The display is only provided to help editors when editing the concept map.
        • equivalence
          Enumeration<Enumerations.ConceptMapEquivalence> equivalence
          The equivalence between the source and target concepts (counting for the dependencies and products). The equivalence is read from target to source (e.g. the target is 'wider' than the source).
        • product
          List<ConceptMap.OtherElementComponent> product
          A set of additional outcomes from this mapping to other elements. To properly execute this mapping, the specified element must be mapped to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but the equivalence cannot be relied on.
    • Class org.hl7.fhir.r4.model.Condition

      class Condition extends DomainResource implements Serializable
      serialVersionUID:
      186776568L
      • Serialized Fields

        • abatement
          Type abatement
          The date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" - Conditions are never really resolved, but they can abate.
        • asserter
          Reference asserter
          Individual who is making the condition statement.
        • asserterTarget
          Resource asserterTarget
          The actual object that is the target of the reference (Individual who is making the condition statement.)
        • bodySite
          List<CodeableConcept> bodySite
          The anatomical location where this condition manifests itself.
        • category
          List<CodeableConcept> category
          A category assigned to the condition.
        • clinicalStatus
          CodeableConcept clinicalStatus
          The clinical status of the condition.
        • code
          CodeableConcept code
          Identification of the condition, problem or diagnosis.
        • encounter
          Reference encounter
          The Encounter during which this Condition was created or to which the creation of this record is tightly associated.
        • encounterTarget
          Encounter encounterTarget
          The actual object that is the target of the reference (The Encounter during which this Condition was created or to which the creation of this record is tightly associated.)
        • evidence
          List<Condition.ConditionEvidenceComponent> evidence
          Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.
        • identifier
          List<Identifier> identifier
          Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
        • note
          List<Annotation> note
          Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.
        • onset
          Type onset
          Estimated or actual date or date-time the condition began, in the opinion of the clinician.
        • recordedDate
          DateTimeType recordedDate
          The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.
        • recorder
          Reference recorder
          Individual who recorded the record and takes responsibility for its content.
        • recorderTarget
          Resource recorderTarget
          The actual object that is the target of the reference (Individual who recorded the record and takes responsibility for its content.)
        • severity
          CodeableConcept severity
          A subjective assessment of the severity of the condition as evaluated by the clinician.
        • stage
          List<Condition.ConditionStageComponent> stage
          Clinical stage or grade of a condition. May include formal severity assessments.
        • subject
          Reference subject
          Indicates the patient or group who the condition record is associated with.
        • subjectTarget
          Resource subjectTarget
          The actual object that is the target of the reference (Indicates the patient or group who the condition record is associated with.)
        • verificationStatus
          CodeableConcept verificationStatus
          The verification status to support the clinical status of the condition.
    • Class org.hl7.fhir.r4.model.Condition.ConditionEvidenceComponent

      class ConditionEvidenceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1135831276L
      • Serialized Fields

        • code
          List<CodeableConcept> code
          A manifestation or symptom that led to the recording of this condition.
        • detail
          List<Reference> detail
          Links to other relevant information, including pathology reports.
        • detailTarget
          List<Resource> detailTarget
          The actual objects that are the target of the reference (Links to other relevant information, including pathology reports.)
    • Class org.hl7.fhir.r4.model.Condition.ConditionStageComponent

      class ConditionStageComponent extends BackboneElement implements Serializable
      serialVersionUID:
      668627986L
      • Serialized Fields

        • assessment
          List<Reference> assessment
          Reference to a formal record of the evidence on which the staging assessment is based.
        • assessmentTarget
          List<Resource> assessmentTarget
          The actual objects that are the target of the reference (Reference to a formal record of the evidence on which the staging assessment is based.)
        • summary
          CodeableConcept summary
          A simple summary of the stage such as "Stage 3". The determination of the stage is disease-specific.
        • type
          CodeableConcept type
          The kind of staging, such as pathological or clinical staging.
    • Class org.hl7.fhir.r4.model.Consent

      class Consent extends DomainResource implements Serializable
      serialVersionUID:
      206528051L
      • Serialized Fields

        • category
          List<CodeableConcept> category
          A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.
        • dateTime
          DateTimeType dateTime
          When this Consent was issued / created / indexed.
        • identifier
          List<Identifier> identifier
          Unique identifier for this copy of the Consent Statement.
        • organization
          List<Reference> organization
          The organization that manages the consent, and the framework within which it is executed.
        • organizationTarget
          List<Organization> organizationTarget
          The actual objects that are the target of the reference (The organization that manages the consent, and the framework within which it is executed.)
        • patient
          Reference patient
          The patient/healthcare consumer to whom this consent applies.
        • patientTarget
          Patient patientTarget
          The actual object that is the target of the reference (The patient/healthcare consumer to whom this consent applies.)
        • performer
          List<Reference> performer
          Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.
        • performerTarget
          List<Resource> performerTarget
          The actual objects that are the target of the reference (Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.)
        • policy
          List<Consent.ConsentPolicyComponent> policy
          The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
        • policyRule
          CodeableConcept policyRule
          A reference to the specific base computable regulation or policy.
        • provision
          Consent.provisionComponent provision
          An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.
        • scope
          CodeableConcept scope
          A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible.
        • source
          Type source
          The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.
        • status
          Enumeration<Consent.ConsentState> status
          Indicates the current state of this consent.
        • verification
          List<Consent.ConsentVerificationComponent> verification
          Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.
    • Class org.hl7.fhir.r4.model.Consent.ConsentDataMeaningEnumFactory

      class ConsentDataMeaningEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Consent.ConsentPolicyComponent

      class ConsentPolicyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      672275705L
      • Serialized Fields

        • authority
          UriType authority
          Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives.
        • uri
          UriType uri
          The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
    • Class org.hl7.fhir.r4.model.Consent.ConsentProvisionTypeEnumFactory

      class ConsentProvisionTypeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Consent.ConsentStateEnumFactory

      class ConsentStateEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Consent.ConsentVerificationComponent

      class ConsentVerificationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1305161458L
      • Serialized Fields

        • verificationDate
          DateTimeType verificationDate
          Date verification was collected.
        • verified
          BooleanType verified
          Has the instruction been verified.
        • verifiedWith
          Reference verifiedWith
          Who verified the instruction (Patient, Relative or other Authorized Person).
        • verifiedWithTarget
          Resource verifiedWithTarget
          The actual object that is the target of the reference (Who verified the instruction (Patient, Relative or other Authorized Person).)
    • Class org.hl7.fhir.r4.model.Consent.provisionActorComponent

      class provisionActorComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1152919415L
      • Serialized Fields

        • reference
          Reference reference
          The resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers').
        • referenceTarget
          Resource referenceTarget
          The actual object that is the target of the reference (The resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers').)
        • role
          CodeableConcept role
          How the individual is involved in the resources content that is described in the exception.
    • Class org.hl7.fhir.r4.model.Consent.provisionComponent

      class provisionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1280172451L
      • Serialized Fields

        • action
          List<CodeableConcept> action
          Actions controlled by this Rule.
        • actor
          List<Consent.provisionActorComponent> actor
          Who or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').
        • class_
          List<Coding> class_
          The class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to.
        • code
          List<CodeableConcept> code
          If this code is found in an instance, then the rule applies.
        • data
          List<Consent.provisionDataComponent> data
          The resources controlled by this rule if specific resources are referenced.
        • dataPeriod
          Period dataPeriod
          Clinical or Operational Relevant period of time that bounds the data controlled by this rule.
        • period
          Period period
          The timeframe in this rule is valid.
        • provision
          List<Consent.provisionComponent> provision
          Rules which provide exceptions to the base rule or subrules.
        • purpose
          List<Coding> purpose
          The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule.
        • securityLabel
          List<Coding> securityLabel
          A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.
        • type
          Enumeration<Consent.ConsentProvisionType> type
          Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules.
    • Class org.hl7.fhir.r4.model.Consent.provisionDataComponent

      class provisionDataComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -424898645L
      • Serialized Fields

        • meaning
          Enumeration<Consent.ConsentDataMeaning> meaning
          How the resource reference is interpreted when testing consent restrictions.
        • reference
          Reference reference
          A reference to a specific resource that defines which resources are covered by this consent.
        • referenceTarget
          Resource referenceTarget
          The actual object that is the target of the reference (A reference to a specific resource that defines which resources are covered by this consent.)
    • Class org.hl7.fhir.r4.model.ContactDetail

      class ContactDetail extends Type implements Serializable
      serialVersionUID:
      816838773L
      • Serialized Fields

        • name
          StringType name
          The name of an individual to contact.
        • telecom
          List<ContactPoint> telecom
          The contact details for the individual (if a name was provided) or the organization.
    • Class org.hl7.fhir.r4.model.ContactPoint

      class ContactPoint extends Type implements Serializable
      serialVersionUID:
      1509610874L
      • Serialized Fields

        • period
          Period period
          Time period when the contact point was/is in use.
        • rank
          PositiveIntType rank
          Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
        • system
          Enumeration<ContactPoint.ContactPointSystem> system
          Telecommunications form for contact point - what communications system is required to make use of the contact.
        • use
          Enumeration<ContactPoint.ContactPointUse> use
          Identifies the purpose for the contact point.
        • value
          StringType value
          The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
    • Class org.hl7.fhir.r4.model.ContactPoint.ContactPointSystemEnumFactory

      class ContactPointSystemEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.ContactPoint.ContactPointUseEnumFactory

      class ContactPointUseEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Contract

      class Contract extends DomainResource implements Serializable
      serialVersionUID:
      -1388892487L
      • Serialized Fields

        • alias
          List<StringType> alias
          Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.g., a domain specific contract number related to legislation.
        • applies
          Period applies
          Relevant time or time-period when this Contract is applicable.
        • author
          Reference author
          The individual or organization that authored the Contract definition, derivative, or instance in any legal state.
        • authority
          List<Reference> authority
          A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.
        • authorityTarget
          List<Organization> authorityTarget
          The actual objects that are the target of the reference (A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.)
        • authorTarget
          Resource authorTarget
          The actual object that is the target of the reference (The individual or organization that authored the Contract definition, derivative, or instance in any legal state.)
        • contentDefinition
          Contract.ContentDefinitionComponent contentDefinition
          Precusory content developed with a focus and intent of supporting the formation a Contract instance, which may be associated with and transformable into a Contract.
        • contentDerivative
          CodeableConcept contentDerivative
          The minimal content derived from the basal information source at a specific stage in its lifecycle.
        • domain
          List<Reference> domain
          Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.
        • domainTarget
          List<Location> domainTarget
          The actual objects that are the target of the reference (Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.)
        • expirationType
          CodeableConcept expirationType
          Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract.
        • friendly
          List<Contract.FriendlyLanguageComponent> friendly
          The "patient friendly language" versionof the Contract in whole or in parts. "Patient friendly language" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.
        • identifier
          List<Identifier> identifier
          Unique identifier for this Contract or a derivative that references a Source Contract.
        • instantiatesCanonical
          Reference instantiatesCanonical
          The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.
        • instantiatesCanonicalTarget
          Contract instantiatesCanonicalTarget
          The actual object that is the target of the reference (The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.)
        • instantiatesUri
          UriType instantiatesUri
          The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.
        • issued
          DateTimeType issued
          When this Contract was issued.
        • legal
          List<Contract.LegalLanguageComponent> legal
          List of Legal expressions or representations of this Contract.
        • legallyBinding
          Type legallyBinding
          Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the "source of truth" and which would be the basis for legal action related to enforcement of this Contract.
        • legalState
          CodeableConcept legalState
          Legal states of the formation of a legal instrument, which is a formally executed written document that can be formally attributed to its author, records and formally expresses a legally enforceable act, process, or contractual duty, obligation, or right, and therefore evidences that act, process, or agreement.
        • name
          StringType name
          A natural language name identifying this Contract definition, derivative, or instance in any legal state. Provides additional information about its content. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • relevantHistory
          List<Reference> relevantHistory
          Links to Provenance records for past versions of this Contract definition, derivative, or instance, which identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the Contract. The Provence.entity indicates the target that was changed in the update. http://build.fhir.org/provenance-definitions.html#Provenance.entity.
        • relevantHistoryTarget
          List<Provenance> relevantHistoryTarget
          The actual objects that are the target of the reference (Links to Provenance records for past versions of this Contract definition, derivative, or instance, which identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the Contract. The Provence.entity indicates the target that was changed in the update. http://build.fhir.org/provenance-definitions.html#Provenance.entity.)
        • rule
          List<Contract.ComputableLanguageComponent> rule
          List of Computable Policy Rule Language Representations of this Contract.
        • scope
          CodeableConcept scope
          A selector of legal concerns for this Contract definition, derivative, or instance in any legal state.
        • signer
          List<Contract.SignatoryComponent> signer
          Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness.
        • site
          List<Reference> site
          Sites in which the contract is complied with, exercised, or in force.
        • siteTarget
          List<Location> siteTarget
          The actual objects that are the target of the reference (Sites in which the contract is complied with, exercised, or in force.)
        • status
          Enumeration<Contract.ContractStatus> status
          The status of the resource instance.
        • subject
          List<Reference> subject
          The target entity impacted by or of interest to parties to the agreement.
        • subjectTarget
          List<Resource> subjectTarget
          The actual objects that are the target of the reference (The target entity impacted by or of interest to parties to the agreement.)
        • subtitle
          StringType subtitle
          An explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.
        • subType
          List<CodeableConcept> subType
          Sub-category for the Contract that distinguishes the kinds of systems that would be interested in the Contract within the context of the Contract's scope.
        • supportingInfo
          List<Reference> supportingInfo
          Information that may be needed by/relevant to the performer in their execution of this term action.
        • supportingInfoTarget
          List<Resource> supportingInfoTarget
          The actual objects that are the target of the reference (Information that may be needed by/relevant to the performer in their execution of this term action.)
        • term
          List<Contract.TermComponent> term
          One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
        • title
          StringType title
          A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.
        • topic
          Type topic
          Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.
        • type
          CodeableConcept type
          A high-level category for the legal instrument, whether constructed as a Contract definition, derivative, or instance in any legal state. Provides additional information about its content within the context of the Contract's scope to distinguish the kinds of systems that would be interested in the contract.
        • url
          UriType url
          Canonical identifier for this contract, represented as a URI (globally unique).
        • version
          StringType version
          An edition identifier used for business purposes to label business significant variants.
    • Class org.hl7.fhir.r4.model.Contract.ActionComponent

      class ActionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -178728180L
      • Serialized Fields

        • context
          Reference context
          Encounter or Episode with primary association to specified term activity.
        • contextLinkId
          List<StringType> contextLinkId
          Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.
        • contextTarget
          Resource contextTarget
          The actual object that is the target of the reference (Encounter or Episode with primary association to specified term activity.)
        • doNotPerform
          BooleanType doNotPerform
          True if the term prohibits the action.
        • intent
          CodeableConcept intent
          Reason or purpose for the action stipulated by this Contract Provision.
        • linkId
          List<StringType> linkId
          Id [identifier??] of the clause or question text related to this action in the referenced form or QuestionnaireResponse.
        • note
          List<Annotation> note
          Comments made about the term action made by the requester, performer, subject or other participants.
        • occurrence
          Type occurrence
          When action happens.
        • performer
          Reference performer
          Indicates who or what is being asked to perform (or not perform) the ction.
        • performerLinkId
          List<StringType> performerLinkId
          Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.
        • performerRole
          CodeableConcept performerRole
          The type of role or competency of an individual desired or required to perform or not perform the action.
        • performerTarget
          Resource performerTarget
          The actual object that is the target of the reference (Indicates who or what is being asked to perform (or not perform) the ction.)
        • performerType
          List<CodeableConcept> performerType
          The type of individual that is desired or required to perform or not perform the action.
        • reason
          List<StringType> reason
          Describes why the action is to be performed or not performed in textual form.
        • reasonCode
          List<CodeableConcept> reasonCode
          Rationale for the action to be performed or not performed. Describes why the action is permitted or prohibited.
        • reasonLinkId
          List<StringType> reasonLinkId
          Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.
        • reasonReference
          List<Reference> reasonReference
          Indicates another resource whose existence justifies permitting or not permitting this action.
        • reasonReferenceTarget
          List<Resource> reasonReferenceTarget
          The actual objects that are the target of the reference (Indicates another resource whose existence justifies permitting or not permitting this action.)
        • requester
          List<Reference> requester
          Who or what initiated the action and has responsibility for its activation.
        • requesterLinkId
          List<StringType> requesterLinkId
          Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.
        • requesterTarget
          List<Resource> requesterTarget
          The actual objects that are the target of the reference (Who or what initiated the action and has responsibility for its activation.)
        • securityLabelNumber
          List<UnsignedIntType> securityLabelNumber
          Security labels that protects the action.
        • status
          CodeableConcept status
          Current state of the term action.
        • subject
          List<Contract.ActionSubjectComponent> subject
          Entity of the action.
        • type
          CodeableConcept type
          Activity or service obligation to be done or not done, performed or not performed, effectuated or not by this Contract term.
    • Class org.hl7.fhir.r4.model.Contract.ActionSubjectComponent

      class ActionSubjectComponent extends BackboneElement implements Serializable
      serialVersionUID:
      128949255L
      • Serialized Fields

        • reference
          List<Reference> reference
          The entity the action is performed or not performed on or for.
        • referenceTarget
          List<Resource> referenceTarget
          The actual objects that are the target of the reference (The entity the action is performed or not performed on or for.)
        • role
          CodeableConcept role
          Role type of agent assigned roles in this Contract.
    • Class org.hl7.fhir.r4.model.Contract.AnswerComponent

      class AnswerComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -732981989L
      • Serialized Fields

        • value
          Type value
          Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.
    • Class org.hl7.fhir.r4.model.Contract.AssetContextComponent

      class AssetContextComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -634115628L
      • Serialized Fields

        • code
          List<CodeableConcept> code
          Coded representation of the context generally or of the Referenced entity, such as the asset holder type or location.
        • reference
          Reference reference
          Asset context reference may include the creator, custodian, or owning Person or Organization (e.g., bank, repository), location held, e.g., building, jurisdiction.
        • referenceTarget
          Resource referenceTarget
          The actual object that is the target of the reference (Asset context reference may include the creator, custodian, or owning Person or Organization (e.g., bank, repository), location held, e.g., building, jurisdiction.)
        • text
          StringType text
          Context description.
    • Class org.hl7.fhir.r4.model.Contract.ComputableLanguageComponent

      class ComputableLanguageComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1763459053L
      • Serialized Fields

        • content
          Type content
          Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal).
    • Class org.hl7.fhir.r4.model.Contract.ContentDefinitionComponent

      class ContentDefinitionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -699592864L
      • Serialized Fields

        • copyright
          MarkdownType copyright
          A copyright statement relating to Contract precursor content. Copyright statements are generally legal restrictions on the use and publishing of the Contract precursor content.
        • publicationDate
          DateTimeType publicationDate
          The date (and optionally time) when the contract was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the contract changes.
        • publicationStatus
          Enumeration<Contract.ContractPublicationStatus> publicationStatus
          amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated.
        • publisher
          Reference publisher
          The individual or organization that published the Contract precursor content.
        • publisherTarget
          Resource publisherTarget
          The actual object that is the target of the reference (The individual or organization that published the Contract precursor content.)
        • subType
          CodeableConcept subType
          Detailed Precusory content type.
        • type
          CodeableConcept type
          Precusory content structure and use, i.e., a boilerplate, template, application for a contract such as an insurance policy or benefits under a program, e.g., workers compensation.
    • Class org.hl7.fhir.r4.model.Contract.ContractAssetComponent

      class ContractAssetComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1080398792L
      • Serialized Fields

        • answer
          List<Contract.AnswerComponent> answer
          Response to assets.
        • condition
          StringType condition
          Description of the quality and completeness of the asset that imay be a factor in its valuation.
        • context
          List<Contract.AssetContextComponent> context
          Circumstance of the asset.
        • linkId
          List<StringType> linkId
          Id [identifier??] of the clause or question text about the asset in the referenced form or QuestionnaireResponse.
        • period
          List<Period> period
          Asset relevant contractual time period.
        • periodType
          List<CodeableConcept> periodType
          Type of Asset availability for use or ownership.
        • relationship
          Coding relationship
          Specifies the applicability of the term to an asset resource instance, and instances it refers to orinstances that refer to it, and/or are owned by the offeree.
        • scope
          CodeableConcept scope
          Differentiates the kind of the asset .
        • securityLabelNumber
          List<UnsignedIntType> securityLabelNumber
          Security labels that protects the asset.
        • subtype
          List<CodeableConcept> subtype
          May be a subtype or part of an offered asset.
        • text
          StringType text
          Clause or question text (Prose Object) concerning the asset in a linked form, such as a QuestionnaireResponse used in the formation of the contract.
        • type
          List<CodeableConcept> type
          Target entity type about which the term may be concerned.
        • typeReference
          List<Reference> typeReference
          Associated entities.
        • typeReferenceTarget
          List<Resource> typeReferenceTarget
          The actual objects that are the target of the reference (Associated entities.)
        • usePeriod
          List<Period> usePeriod
          Time period of asset use.
        • valuedItem
          List<Contract.ValuedItemComponent> valuedItem
          Contract Valued Item List.
    • Class org.hl7.fhir.r4.model.Contract.ContractOfferComponent

      class ContractOfferComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -395674449L
      • Serialized Fields

        • answer
          List<Contract.AnswerComponent> answer
          Response to offer text.
        • decision
          CodeableConcept decision
          Type of choice made by accepting party with respect to an offer made by an offeror/ grantee.
        • decisionMode
          List<CodeableConcept> decisionMode
          How the decision about a Contract was conveyed.
        • identifier
          List<Identifier> identifier
          Unique identifier for this particular Contract Provision.
        • linkId
          List<StringType> linkId
          The id of the clause or question text of the offer in the referenced questionnaire/response.
        • party
          List<Contract.ContractPartyComponent> party
          Offer Recipient.
        • securityLabelNumber
          List<UnsignedIntType> securityLabelNumber
          Security labels that protects the offer.
        • text
          StringType text
          Human readable form of this Contract Offer.
        • topic
          Reference topic
          The owner of an asset has the residual control rights over the asset: the right to decide all usages of the asset in any way not inconsistent with a prior contract, custom, or law (Hart, 1995, p. 30).
        • topicTarget
          Resource topicTarget
          The actual object that is the target of the reference (The owner of an asset has the residual control rights over the asset: the right to decide all usages of the asset in any way not inconsistent with a prior contract, custom, or law (Hart, 1995, p. 30).)
        • type
          CodeableConcept type
          Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit.
    • Class org.hl7.fhir.r4.model.Contract.ContractPartyComponent

      class ContractPartyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      128949255L
      • Serialized Fields

        • reference
          List<Reference> reference
          Participant in the offer.
        • referenceTarget
          List<Resource> referenceTarget
          The actual objects that are the target of the reference (Participant in the offer.)
        • role
          CodeableConcept role
          How the party participates in the offer.
    • Class org.hl7.fhir.r4.model.Contract.ContractPublicationStatusEnumFactory

      class ContractPublicationStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Contract.ContractStatusEnumFactory

      class ContractStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Contract.FriendlyLanguageComponent

      class FriendlyLanguageComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1763459053L
      • Serialized Fields

        • content
          Type content
          Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability.
    • Class org.hl7.fhir.r4.model.Contract.LegalLanguageComponent

      class LegalLanguageComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1763459053L
      • Serialized Fields

        • content
          Type content
          Contract legal text in human renderable form.
    • Class org.hl7.fhir.r4.model.Contract.SecurityLabelComponent

      class SecurityLabelComponent extends BackboneElement implements Serializable
      serialVersionUID:
      788281758L
      • Serialized Fields

        • category
          List<Coding> category
          Security label privacy tag that species the applicable privacy and security policies governing this term and/or term elements.
        • classification
          Coding classification
          Security label privacy tag that species the level of confidentiality protection required for this term and/or term elements.
        • control
          List<Coding> control
          Security label privacy tag that species the manner in which term and/or term elements are to be protected.
        • number
          List<UnsignedIntType> number
          Number used to link this term or term element to the applicable Security Label.
    • Class org.hl7.fhir.r4.model.Contract.SignatoryComponent

      class SignatoryComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1948139228L
      • Serialized Fields

        • party
          Reference party
          Party which is a signator to this Contract.
        • partyTarget
          Resource partyTarget
          The actual object that is the target of the reference (Party which is a signator to this Contract.)
        • signature
          List<Signature> signature
          Legally binding Contract DSIG signature contents in Base64.
        • type
          Coding type
          Role of this Contract signer, e.g. notary, grantee.
    • Class org.hl7.fhir.r4.model.Contract.TermComponent

      class TermComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -460907186L
      • Serialized Fields

        • action
          List<Contract.ActionComponent> action
          An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
        • applies
          Period applies
          Relevant time or time-period when this Contract Provision is applicable.
        • asset
          List<Contract.ContractAssetComponent> asset
          Contract Term Asset List.
        • group
          List<Contract.TermComponent> group
          Nested group of Contract Provisions.
        • identifier
          Identifier identifier
          Unique identifier for this particular Contract Provision.
        • issued
          DateTimeType issued
          When this Contract Provision was issued.
        • offer
          Contract.ContractOfferComponent offer
          The matter of concern in the context of this provision of the agrement.
        • securityLabel
          List<Contract.SecurityLabelComponent> securityLabel
          Security labels that protect the handling of information about the term and its elements, which may be specifically identified..
        • subType
          CodeableConcept subType
          A specialized legal clause or condition based on overarching contract type.
        • text
          StringType text
          Statement of a provision in a policy or a contract.
        • topic
          Type topic
          The entity that the term applies to.
        • type
          CodeableConcept type
          A legal clause or condition contained within a contract that requires one or both parties to perform a particular requirement by some specified time or prevents one or both parties from performing a particular requirement by some specified time.
    • Class org.hl7.fhir.r4.model.Contract.ValuedItemComponent

      class ValuedItemComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1894951601L
      • Serialized Fields

        • effectiveTime
          DateTimeType effectiveTime
          Indicates the time during which this Contract ValuedItem information is effective.
        • entity
          Type entity
          Specific type of Contract Valued Item that may be priced.
        • factor
          DecimalType factor
          A real number that represents a multiplier used in determining the overall value of the Contract Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
        • identifier
          Identifier identifier
          Identifies a Contract Valued Item instance.
        • linkId
          List<StringType> linkId
          Id of the clause or question text related to the context of this valuedItem in the referenced form or QuestionnaireResponse.
        • net
          Money net
          Expresses the product of the Contract Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.
        • payment
          StringType payment
          Terms of valuation.
        • paymentDate
          DateTimeType paymentDate
          When payment is due.
        • points
          DecimalType points
          An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Valued Item delivered. The concept of Points allows for assignment of point values for a Contract Valued Item, such that a monetary amount can be assigned to each point.
        • quantity
          Quantity quantity
          Specifies the units by which the Contract Valued Item is measured or counted, and quantifies the countable or measurable Contract Valued Item instances.
        • recipient
          Reference recipient
          Who will receive payment.
        • recipientTarget
          Resource recipientTarget
          The actual object that is the target of the reference (Who will receive payment.)
        • responsible
          Reference responsible
          Who will make payment.
        • responsibleTarget
          Resource responsibleTarget
          The actual object that is the target of the reference (Who will make payment.)
        • securityLabelNumber
          List<UnsignedIntType> securityLabelNumber
          A set of security labels that define which terms are controlled by this condition.
        • unitPrice
          Money unitPrice
          A Contract Valued Item unit valuation measure.
    • Class org.hl7.fhir.r4.model.Contributor

      class Contributor extends Type implements Serializable
      serialVersionUID:
      -609887113L
    • Class org.hl7.fhir.r4.model.Contributor.ContributorTypeEnumFactory

      class ContributorTypeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Count

      class Count extends Quantity implements Serializable
      serialVersionUID:
      0L
    • Class org.hl7.fhir.r4.model.Coverage

      class Coverage extends DomainResource implements Serializable
      serialVersionUID:
      212315315L
      • Serialized Fields

        • beneficiary
          Reference beneficiary
          The party who benefits from the insurance coverage; the patient when products and/or services are provided.
        • beneficiaryTarget
          Patient beneficiaryTarget
          The actual object that is the target of the reference (The party who benefits from the insurance coverage; the patient when products and/or services are provided.)
        • class_
          List<Coverage.ClassComponent> class_
          A suite of underwriter specific classifiers.
        • contract
          List<Reference> contract
          The policy(s) which constitute this insurance coverage.
        • contractTarget
          List<Contract> contractTarget
          The actual objects that are the target of the reference (The policy(s) which constitute this insurance coverage.)
        • costToBeneficiary
          List<Coverage.CostToBeneficiaryComponent> costToBeneficiary
          A suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card.
        • dependent
          StringType dependent
          A unique identifier for a dependent under the coverage.
        • identifier
          List<Identifier> identifier
          A unique identifier assigned to this coverage.
        • network
          StringType network
          The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.
        • order
          PositiveIntType order
          The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care.
        • payor
          List<Reference> payor
          The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.
        • payorTarget
          List<Resource> payorTarget
          The actual objects that are the target of the reference (The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.)
        • period
          Period period
          Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.
        • policyHolder
          Reference policyHolder
          The party who 'owns' the insurance policy.
        • policyHolderTarget
          Resource policyHolderTarget
          The actual object that is the target of the reference (The party who 'owns' the insurance policy.)
        • relationship
          CodeableConcept relationship
          The relationship of beneficiary (patient) to the subscriber.
        • status
          Enumeration<Coverage.CoverageStatus> status
          The status of the resource instance.
        • subrogation
          BooleanType subrogation
          When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.
        • subscriber
          Reference subscriber
          The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.
        • subscriberId
          StringType subscriberId
          The insurer assigned ID for the Subscriber.
        • subscriberTarget
          Resource subscriberTarget
          The actual object that is the target of the reference (The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.)
        • type
          CodeableConcept type
          The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.
    • Class org.hl7.fhir.r4.model.Coverage.ClassComponent

      class ClassComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1501519769L
      • Serialized Fields

        • name
          StringType name
          A short description for the class.
        • type
          CodeableConcept type
          The type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan.
        • value
          StringType value
          The alphanumeric string value associated with the insurer issued label.
    • Class org.hl7.fhir.r4.model.Coverage.CostToBeneficiaryComponent

      class CostToBeneficiaryComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1302829059L
      • Serialized Fields

        • exception
          List<Coverage.ExemptionComponent> exception
          A suite of codes indicating exceptions or reductions to patient costs and their effective periods.
        • type
          CodeableConcept type
          The category of patient centric costs associated with treatment.
        • value
          Type value
          The amount due from the patient for the cost category.
    • Class org.hl7.fhir.r4.model.Coverage.CoverageStatusEnumFactory

      class CoverageStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Coverage.ExemptionComponent

      class ExemptionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      523191991L
      • Serialized Fields

        • period
          Period period
          The timeframe during when the exception is in force.
        • type
          CodeableConcept type
          The code for the specific exception.
    • Class org.hl7.fhir.r4.model.CoverageEligibilityRequest

      class CoverageEligibilityRequest extends DomainResource implements Serializable
      serialVersionUID:
      1371127108L
      • Serialized Fields

        • created
          DateTimeType created
          The date when this resource was created.
        • enterer
          Reference enterer
          Person who created the request.
        • entererTarget
          Resource entererTarget
          The actual object that is the target of the reference (Person who created the request.)
        • facility
          Reference facility
          Facility where the services are intended to be provided.
        • facilityTarget
          Location facilityTarget
          The actual object that is the target of the reference (Facility where the services are intended to be provided.)
        • identifier
          List<Identifier> identifier
          A unique identifier assigned to this coverage eligiblity request.
        • insurance
          List<CoverageEligibilityRequest.InsuranceComponent> insurance
          Financial instruments for reimbursement for the health care products and services.
        • insurer
          Reference insurer
          The Insurer who issued the coverage in question and is the recipient of the request.
        • insurerTarget
          Organization insurerTarget
          The actual object that is the target of the reference (The Insurer who issued the coverage in question and is the recipient of the request.)
        • item
          List<CoverageEligibilityRequest.DetailsComponent> item
          Service categories or billable services for which benefit details and/or an authorization prior to service delivery may be required by the payor.
        • patient
          Reference patient
          The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.
        • patientTarget
          Patient patientTarget
          The actual object that is the target of the reference (The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.)
        • priority
          CodeableConcept priority
          When the requestor expects the processor to complete processing.
        • provider
          Reference provider
          The provider which is responsible for the request.
        • providerTarget
          Resource providerTarget
          The actual object that is the target of the reference (The provider which is responsible for the request.)
        • purpose
          List<Enumeration<CoverageEligibilityRequest.EligibilityRequestPurpose>> purpose
          Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.
        • serviced
          Type serviced
          The date or dates when the enclosed suite of services were performed or completed.
        • status
          Enumeration<CoverageEligibilityRequest.EligibilityRequestStatus> status
          The status of the resource instance.
        • supportingInfo
          List<CoverageEligibilityRequest.SupportingInformationComponent> supportingInfo
          Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.
    • Class org.hl7.fhir.r4.model.CoverageEligibilityRequest.DetailsComponent

      class DetailsComponent extends BackboneElement implements Serializable
      serialVersionUID:
      389110539L
      • Serialized Fields

        • category
          CodeableConcept category
          Code to identify the general type of benefits under which products and services are provided.
        • detail
          List<Reference> detail
          The plan/proposal/order describing the proposed service in detail.
        • detailTarget
          List<Resource> detailTarget
          The actual objects that are the target of the reference (The plan/proposal/order describing the proposed service in detail.)
        • diagnosis
          List<CoverageEligibilityRequest.DiagnosisComponent> diagnosis
          Patient diagnosis for which care is sought.
        • facility
          Reference facility
          Facility where the services will be provided.
        • facilityTarget
          Resource facilityTarget
          The actual object that is the target of the reference (Facility where the services will be provided.)
        • modifier
          List<CodeableConcept> modifier
          Item typification or modifiers codes to convey additional context for the product or service.
        • productOrService
          CodeableConcept productOrService
          This contains the product, service, drug or other billing code for the item.
        • provider
          Reference provider
          The practitioner who is responsible for the product or service to be rendered to the patient.
        • providerTarget
          Resource providerTarget
          The actual object that is the target of the reference (The practitioner who is responsible for the product or service to be rendered to the patient.)
        • quantity
          Quantity quantity
          The number of repetitions of a service or product.
        • supportingInfoSequence
          List<PositiveIntType> supportingInfoSequence
          Exceptions, special conditions and supporting information applicable for this service or product line.
        • unitPrice
          Money unitPrice
          The amount charged to the patient by the provider for a single unit.
    • Class org.hl7.fhir.r4.model.CoverageEligibilityRequest.DiagnosisComponent

      class DiagnosisComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -454532709L
      • Serialized Fields

        • diagnosis
          Type diagnosis
          The nature of illness or problem in a coded form or as a reference to an external defined Condition.
    • Class org.hl7.fhir.r4.model.CoverageEligibilityRequest.EligibilityRequestPurposeEnumFactory

      class EligibilityRequestPurposeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CoverageEligibilityRequest.EligibilityRequestStatusEnumFactory

      class EligibilityRequestStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CoverageEligibilityRequest.InsuranceComponent

      class InsuranceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      692505842L
      • Serialized Fields

        • businessArrangement
          StringType businessArrangement
          A business agreement number established between the provider and the insurer for special business processing purposes.
        • coverage
          Reference coverage
          Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.
        • coverageTarget
          Coverage coverageTarget
          The actual object that is the target of the reference (Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.)
        • focal
          BooleanType focal
          A flag to indicate that this Coverage is to be used for evaluation of this request when set to true.
    • Class org.hl7.fhir.r4.model.CoverageEligibilityRequest.SupportingInformationComponent

      class SupportingInformationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      819254843L
      • Serialized Fields

        • appliesToAll
          BooleanType appliesToAll
          The supporting materials are applicable for all detail items, product/servce categories and specific billing codes.
        • information
          Reference information
          Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
        • informationTarget
          Resource informationTarget
          The actual object that is the target of the reference (Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.)
        • sequence
          PositiveIntType sequence
          A number to uniquely identify supporting information entries.
    • Class org.hl7.fhir.r4.model.CoverageEligibilityResponse

      class CoverageEligibilityResponse extends DomainResource implements Serializable
      serialVersionUID:
      -266280848L
      • Serialized Fields

        • created
          DateTimeType created
          The date this resource was created.
        • disposition
          StringType disposition
          A human readable description of the status of the adjudication.
        • error
          List<CoverageEligibilityResponse.ErrorsComponent> error
          Errors encountered during the processing of the request.
        • form
          CodeableConcept form
          A code for the form to be used for printing the content.
        • identifier
          List<Identifier> identifier
          A unique identifier assigned to this coverage eligiblity request.
        • insurance
          List<CoverageEligibilityResponse.InsuranceComponent> insurance
          Financial instruments for reimbursement for the health care products and services.
        • insurer
          Reference insurer
          The Insurer who issued the coverage in question and is the author of the response.
        • insurerTarget
          Organization insurerTarget
          The actual object that is the target of the reference (The Insurer who issued the coverage in question and is the author of the response.)
        • outcome
          Enumeration<Enumerations.RemittanceOutcome> outcome
          The outcome of the request processing.
        • patient
          Reference patient
          The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.
        • patientTarget
          Patient patientTarget
          The actual object that is the target of the reference (The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.)
        • preAuthRef
          StringType preAuthRef
          A reference from the Insurer to which these services pertain to be used on further communication and as proof that the request occurred.
        • purpose
          List<Enumeration<CoverageEligibilityResponse.EligibilityResponsePurpose>> purpose
          Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.
        • request
          Reference request
          Reference to the original request resource.
        • requestor
          Reference requestor
          The provider which is responsible for the request.
        • requestorTarget
          Resource requestorTarget
          The actual object that is the target of the reference (The provider which is responsible for the request.)
        • requestTarget
          CoverageEligibilityRequest requestTarget
          The actual object that is the target of the reference (Reference to the original request resource.)
        • serviced
          Type serviced
          The date or dates when the enclosed suite of services were performed or completed.
        • status
          Enumeration<CoverageEligibilityResponse.EligibilityResponseStatus> status
          The status of the resource instance.
    • Class org.hl7.fhir.r4.model.CoverageEligibilityResponse.BenefitComponent

      class BenefitComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1506285314L
      • Serialized Fields

        • allowed
          Type allowed
          The quantity of the benefit which is permitted under the coverage.
        • type
          CodeableConcept type
          Classification of benefit being provided.
        • used
          Type used
          The quantity of the benefit which have been consumed to date.
    • Class org.hl7.fhir.r4.model.CoverageEligibilityResponse.EligibilityResponsePurposeEnumFactory

      class EligibilityResponsePurposeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CoverageEligibilityResponse.EligibilityResponseStatusEnumFactory

      class EligibilityResponseStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.CoverageEligibilityResponse.ErrorsComponent

      class ErrorsComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1048343046L
      • Serialized Fields

        • code
          CodeableConcept code
          An error code,from a specified code system, which details why the eligibility check could not be performed.
    • Class org.hl7.fhir.r4.model.CoverageEligibilityResponse.InsuranceComponent

      class InsuranceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -567336701L
      • Serialized Fields

        • benefitPeriod
          Period benefitPeriod
          The term of the benefits documented in this response.
        • coverage
          Reference coverage
          Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.
        • coverageTarget
          Coverage coverageTarget
          The actual object that is the target of the reference (Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.)
        • inforce
          BooleanType inforce
          Flag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates.
        • item
          List<CoverageEligibilityResponse.ItemsComponent> item
          Benefits and optionally current balances, and authorization details by category or service.
    • Class org.hl7.fhir.r4.model.CoverageEligibilityResponse.ItemsComponent

      class ItemsComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1779114111L
      • Serialized Fields

        • authorizationRequired
          BooleanType authorizationRequired
          A boolean flag indicating whether a preauthorization is required prior to actual service delivery.
        • authorizationSupporting
          List<CodeableConcept> authorizationSupporting
          Codes or comments regarding information or actions associated with the preauthorization.
        • authorizationUrl
          UriType authorizationUrl
          A web location for obtaining requirements or descriptive information regarding the preauthorization.
        • benefit
          List<CoverageEligibilityResponse.BenefitComponent> benefit
          Benefits used to date.
        • category
          CodeableConcept category
          Code to identify the general type of benefits under which products and services are provided.
        • description
          StringType description
          A richer description of the benefit or services covered.
        • excluded
          BooleanType excluded
          True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.
        • modifier
          List<CodeableConcept> modifier
          Item typification or modifiers codes to convey additional context for the product or service.
        • name
          StringType name
          A short name or tag for the benefit.
        • network
          CodeableConcept network
          Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.
        • productOrService
          CodeableConcept productOrService
          This contains the product, service, drug or other billing code for the item.
        • provider
          Reference provider
          The practitioner who is eligible for the provision of the product or service.
        • providerTarget
          Resource providerTarget
          The actual object that is the target of the reference (The practitioner who is eligible for the provision of the product or service.)
        • term
          CodeableConcept term
          The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.
        • unit
          CodeableConcept unit
          Indicates if the benefits apply to an individual or to the family.
    • Class org.hl7.fhir.r4.model.DataRequirement

      class DataRequirement extends Type implements Serializable
      serialVersionUID:
      74042278L
      • Serialized Fields

        • codeFilter
          List<DataRequirement.DataRequirementCodeFilterComponent> codeFilter
          Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
        • dateFilter
          List<DataRequirement.DataRequirementDateFilterComponent> dateFilter
          Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
        • limit
          PositiveIntType limit
          Specifies a maximum number of results that are required (uses the _count search parameter).
        • mustSupport
          List<StringType> mustSupport
          Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).
        • profile
          List<CanonicalType> profile
          The profile of the required data, specified as the uri of the profile definition.
        • sort
          List<DataRequirement.DataRequirementSortComponent> sort
          Specifies the order of the results to be returned.
        • subject
          Type subject
          The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
        • type
          CodeType type
          The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
    • Class org.hl7.fhir.r4.model.DataRequirement.DataRequirementCodeFilterComponent

      class DataRequirementCodeFilterComponent extends Element implements Serializable
      serialVersionUID:
      -1286212752L
      • Serialized Fields

        • code
          List<Coding> code
          The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.
        • path
          StringType path
          The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.
        • searchParam
          StringType searchParam
          A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.
        • valueSet
          CanonicalType valueSet
          The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.
    • Class org.hl7.fhir.r4.model.DataRequirement.DataRequirementDateFilterComponent

      class DataRequirementDateFilterComponent extends Element implements Serializable
      serialVersionUID:
      1151620053L
      • Serialized Fields

        • path
          StringType path
          The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.
        • searchParam
          StringType searchParam
          A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.
        • value
          Type value
          The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.
    • Class org.hl7.fhir.r4.model.DataRequirement.DataRequirementSortComponent

      class DataRequirementSortComponent extends Element implements Serializable
      serialVersionUID:
      -694498683L
      • Serialized Fields

        • direction
          Enumeration<DataRequirement.SortDirection> direction
          The direction of the sort, ascending or descending.
        • path
          StringType path
          The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.
    • Class org.hl7.fhir.r4.model.DataRequirement.SortDirectionEnumFactory

      class SortDirectionEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.DateTimeType

      class DateTimeType extends BaseDateTimeType implements Externalizable
      serialVersionUID:
      3L
    • Class org.hl7.fhir.r4.model.DateType

      class DateType extends BaseDateTimeType implements Externalizable
      serialVersionUID:
      3L
    • Class org.hl7.fhir.r4.model.DecimalType

      class DecimalType extends PrimitiveType<BigDecimal> implements Externalizable
      serialVersionUID:
      3L
    • Class org.hl7.fhir.r4.model.DetectedIssue

      class DetectedIssue extends DomainResource implements Serializable
      serialVersionUID:
      1404426283L
      • Serialized Fields

        • author
          Reference author
          Individual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review.
        • authorTarget
          Resource authorTarget
          The actual object that is the target of the reference (Individual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review.)
        • code
          CodeableConcept code
          Identifies the general type of issue identified.
        • detail
          StringType detail
          A textual explanation of the detected issue.
        • evidence
          List<DetectedIssue.DetectedIssueEvidenceComponent> evidence
          Supporting evidence or manifestations that provide the basis for identifying the detected issue such as a GuidanceResponse or MeasureReport.
        • identified
          Type identified
          The date or period when the detected issue was initially identified.
        • identifier
          List<Identifier> identifier
          Business identifier associated with the detected issue record.
        • implicated
          List<Reference> implicated
          Indicates the resource representing the current activity or proposed activity that is potentially problematic.
        • implicatedTarget
          List<Resource> implicatedTarget
          The actual objects that are the target of the reference (Indicates the resource representing the current activity or proposed activity that is potentially problematic.)
        • mitigation
          List<DetectedIssue.DetectedIssueMitigationComponent> mitigation
          Indicates an action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.
        • patient
          Reference patient
          Indicates the patient whose record the detected issue is associated with.
        • patientTarget
          Patient patientTarget
          The actual object that is the target of the reference (Indicates the patient whose record the detected issue is associated with.)
        • reference
          UriType reference
          The literature, knowledge-base or similar reference that describes the propensity for the detected issue identified.
        • severity
          Enumeration<DetectedIssue.DetectedIssueSeverity> severity
          Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.
        • status
          Enumeration<DetectedIssue.DetectedIssueStatus> status
          Indicates the status of the detected issue.
    • Class org.hl7.fhir.r4.model.DetectedIssue.DetectedIssueEvidenceComponent

      class DetectedIssueEvidenceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1135831276L
      • Serialized Fields

        • code
          List<CodeableConcept> code
          A manifestation that led to the recording of this detected issue.
        • detail
          List<Reference> detail
          Links to resources that constitute evidence for the detected issue such as a GuidanceResponse or MeasureReport.
        • detailTarget
          List<Resource> detailTarget
          The actual objects that are the target of the reference (Links to resources that constitute evidence for the detected issue such as a GuidanceResponse or MeasureReport.)
    • Class org.hl7.fhir.r4.model.DetectedIssue.DetectedIssueMitigationComponent

      class DetectedIssueMitigationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1928864832L
      • Serialized Fields

        • action
          CodeableConcept action
          Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified issue.
        • author
          Reference author
          Identifies the practitioner who determined the mitigation and takes responsibility for the mitigation step occurring.
        • authorTarget
          Resource authorTarget
          The actual object that is the target of the reference (Identifies the practitioner who determined the mitigation and takes responsibility for the mitigation step occurring.)
        • date
          DateTimeType date
          Indicates when the mitigating action was documented.
    • Class org.hl7.fhir.r4.model.DetectedIssue.DetectedIssueSeverityEnumFactory

      class DetectedIssueSeverityEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.DetectedIssue.DetectedIssueStatusEnumFactory

      class DetectedIssueStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Device

      class Device extends DomainResource implements Serializable
      serialVersionUID:
      -298380419L
      • Serialized Fields

        • contact
          List<ContactPoint> contact
          Contact details for an organization or a particular human that is responsible for the device.
        • definition
          Reference definition
          The reference to the definition for the device.
        • definitionTarget
          DeviceDefinition definitionTarget
          The actual object that is the target of the reference (The reference to the definition for the device.)
        • deviceName
          List<Device.DeviceDeviceNameComponent> deviceName
          This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.
        • distinctIdentifier
          StringType distinctIdentifier
          The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.
        • expirationDate
          DateTimeType expirationDate
          The date and time beyond which this device is no longer valid or should not be used (if applicable).
        • identifier
          List<Identifier> identifier
          Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
        • location
          Reference location
          The place where the device can be found.
        • locationTarget
          Location locationTarget
          The actual object that is the target of the reference (The place where the device can be found.)
        • lotNumber
          StringType lotNumber
          Lot number assigned by the manufacturer.
        • manufactureDate
          DateTimeType manufactureDate
          The date and time when the device was manufactured.
        • manufacturer
          StringType manufacturer
          A name of the manufacturer.
        • modelNumber
          StringType modelNumber
          The model number for the device.
        • note
          List<Annotation> note
          Descriptive information, usage information or implantation information that is not captured in an existing element.
        • owner
          Reference owner
          An organization that is responsible for the provision and ongoing maintenance of the device.
        • ownerTarget
          Organization ownerTarget
          The actual object that is the target of the reference (An organization that is responsible for the provision and ongoing maintenance of the device.)
        • parent
          Reference parent
          The parent device.
        • parentTarget
          Device parentTarget
          The actual object that is the target of the reference (The parent device.)
        • partNumber
          StringType partNumber
          The part number of the device.
        • patient
          Reference patient
          Patient information, If the device is affixed to a person.
        • patientTarget
          Patient patientTarget
          The actual object that is the target of the reference (Patient information, If the device is affixed to a person.)
        • property
          List<Device.DevicePropertyComponent> property
          The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
        • safety
          List<CodeableConcept> safety
          Provides additional safety characteristics about a medical device. For example devices containing latex.
        • serialNumber
          StringType serialNumber
          The serial number assigned by the organization when the device was manufactured.
        • specialization
          List<Device.DeviceSpecializationComponent> specialization
          The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
        • status
          Enumeration<Device.FHIRDeviceStatus> status
          Status of the Device availability.
        • statusReason
          List<CodeableConcept> statusReason
          Reason for the dtatus of the Device availability.
        • type
          CodeableConcept type
          The kind or type of device.
        • udiCarrier
          List<Device.DeviceUdiCarrierComponent> udiCarrier
          Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.
        • url
          UriType url
          A network address on which the device may be contacted directly.
        • version
          List<Device.DeviceVersionComponent> version
          The actual design of the device or software version running on the device.
    • Class org.hl7.fhir.r4.model.Device.DeviceDeviceNameComponent

      class DeviceDeviceNameComponent extends BackboneElement implements Serializable
      serialVersionUID:
      918983440L
      • Serialized Fields

    • Class org.hl7.fhir.r4.model.Device.DeviceNameTypeEnumFactory

      class DeviceNameTypeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Device.DevicePropertyComponent

      class DevicePropertyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1512172633L
      • Serialized Fields

        • type
          CodeableConcept type
          Code that specifies the property DeviceDefinitionPropetyCode (Extensible).
        • valueCode
          List<CodeableConcept> valueCode
          Property value as a code, e.g., NTP4 (synced to NTP).
        • valueQuantity
          List<Quantity> valueQuantity
          Property value as a quantity.
    • Class org.hl7.fhir.r4.model.Device.DeviceSpecializationComponent

      class DeviceSpecializationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1557342629L
      • Serialized Fields

        • systemType
          CodeableConcept systemType
          The standard that is used to operate and communicate.
        • version
          StringType version
          The version of the standard that is used to operate and communicate.
    • Class org.hl7.fhir.r4.model.Device.DeviceUdiCarrierComponent

      class DeviceUdiCarrierComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -191630425L
      • Serialized Fields

        • carrierAIDC
          Base64BinaryType carrierAIDC
          The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - e.g., a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats *SHALL* be base64 encoded.
        • carrierHRF
          StringType carrierHRF
          The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.
        • deviceIdentifier
          StringType deviceIdentifier
          The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.
        • entryType
          Enumeration<Device.UDIEntryType> entryType
          A coded entry to indicate how the data was entered.
        • issuer
          UriType issuer
          Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include : 1) GS1: http://hl7.org/fhir/NamingSystem/gs1-di, 2) HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-dI, 3) ICCBBA for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood-di, 4) ICCBA for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other-di.
        • jurisdiction
          UriType jurisdiction
          The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/fda-udi.
    • Class org.hl7.fhir.r4.model.Device.DeviceVersionComponent

      class DeviceVersionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      645214295L
      • Serialized Fields

    • Class org.hl7.fhir.r4.model.Device.FHIRDeviceStatusEnumFactory

      class FHIRDeviceStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Device.UDIEntryTypeEnumFactory

      class UDIEntryTypeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.DeviceDefinition

      class DeviceDefinition extends DomainResource implements Serializable
      serialVersionUID:
      -2041532433L
      • Serialized Fields

        • capability
          List<DeviceDefinition.DeviceDefinitionCapabilityComponent> capability
          Device capabilities.
        • contact
          List<ContactPoint> contact
          Contact details for an organization or a particular human that is responsible for the device.
        • deviceName
          List<DeviceDefinition.DeviceDefinitionDeviceNameComponent> deviceName
          A name given to the device to identify it.
        • identifier
          List<Identifier> identifier
          Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID.
        • languageCode
          List<CodeableConcept> languageCode
          Language code for the human-readable text strings produced by the device (all supported).
        • manufacturer
          Type manufacturer
          A name of the manufacturer.
        • material
          List<DeviceDefinition.DeviceDefinitionMaterialComponent> material
          A substance used to create the material(s) of which the device is made.
        • modelNumber
          StringType modelNumber
          The model number for the device.
        • note
          List<Annotation> note
          Descriptive information, usage information or implantation information that is not captured in an existing element.
        • onlineInformation
          UriType onlineInformation
          Access to on-line information about the device.
        • owner
          Reference owner
          An organization that is responsible for the provision and ongoing maintenance of the device.
        • ownerTarget
          Organization ownerTarget
          The actual object that is the target of the reference (An organization that is responsible for the provision and ongoing maintenance of the device.)
        • parentDevice
          Reference parentDevice
          The parent device it can be part of.
        • parentDeviceTarget
          DeviceDefinition parentDeviceTarget
          The actual object that is the target of the reference (The parent device it can be part of.)
        • physicalCharacteristics
          ProdCharacteristic physicalCharacteristics
          Dimensions, color etc.
        • property
          List<DeviceDefinition.DeviceDefinitionPropertyComponent> property
          The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
        • quantity
          Quantity quantity
          The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product).
        • safety
          List<CodeableConcept> safety
          Safety characteristics of the device.
        • shelfLifeStorage
          List<ProductShelfLife> shelfLifeStorage
          Shelf Life and storage information.
        • specialization
          List<DeviceDefinition.DeviceDefinitionSpecializationComponent> specialization
          The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
        • type
          CodeableConcept type
          What kind of device or device system this is.
        • udiDeviceIdentifier
          List<DeviceDefinition.DeviceDefinitionUdiDeviceIdentifierComponent> udiDeviceIdentifier
          Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.
        • url
          UriType url
          A network address on which the device may be contacted directly.
        • version
          List<StringType> version
          The available versions of the device, e.g., software versions.
    • Class org.hl7.fhir.r4.model.DeviceDefinition.DeviceDefinitionCapabilityComponent

      class DeviceDefinitionCapabilityComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -192945344L
    • Class org.hl7.fhir.r4.model.DeviceDefinition.DeviceDefinitionDeviceNameComponent

      class DeviceDefinitionDeviceNameComponent extends BackboneElement implements Serializable
      serialVersionUID:
      918983440L
    • Class org.hl7.fhir.r4.model.DeviceDefinition.DeviceDefinitionMaterialComponent

      class DeviceDefinitionMaterialComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1232736508L
      • Serialized Fields

        • allergenicIndicator
          BooleanType allergenicIndicator
          Whether the substance is a known or suspected allergen.
        • alternate
          BooleanType alternate
          Indicates an alternative material of the device.
        • substance
          CodeableConcept substance
          The substance.
    • Class org.hl7.fhir.r4.model.DeviceDefinition.DeviceDefinitionPropertyComponent

      class DeviceDefinitionPropertyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1512172633L
      • Serialized Fields

        • type
          CodeableConcept type
          Code that specifies the property DeviceDefinitionPropetyCode (Extensible).
        • valueCode
          List<CodeableConcept> valueCode
          Property value as a code, e.g., NTP4 (synced to NTP).
        • valueQuantity
          List<Quantity> valueQuantity
          Property value as a quantity.
    • Class org.hl7.fhir.r4.model.DeviceDefinition.DeviceDefinitionSpecializationComponent

      class DeviceDefinitionSpecializationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -249304393L
      • Serialized Fields

        • systemType
          StringType systemType
          The standard that is used to operate and communicate.
        • version
          StringType version
          The version of the standard that is used to operate and communicate.
    • Class org.hl7.fhir.r4.model.DeviceDefinition.DeviceDefinitionUdiDeviceIdentifierComponent

      class DeviceDefinitionUdiDeviceIdentifierComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1577319218L
      • Serialized Fields

        • deviceIdentifier
          StringType deviceIdentifier
          The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier.
        • issuer
          UriType issuer
          The organization that assigns the identifier algorithm.
        • jurisdiction
          UriType jurisdiction
          The jurisdiction to which the deviceIdentifier applies.
    • Class org.hl7.fhir.r4.model.DeviceDefinition.DeviceNameTypeEnumFactory

      class DeviceNameTypeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.DeviceMetric

      class DeviceMetric extends DomainResource implements Serializable
      serialVersionUID:
      1309955219L
      • Serialized Fields

        • calibration
          List<DeviceMetric.DeviceMetricCalibrationComponent> calibration
          Describes the calibrations that have been performed or that are required to be performed.
        • category
          Enumeration<DeviceMetric.DeviceMetricCategory> category
          Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.
        • color
          Enumeration<DeviceMetric.DeviceMetricColor> color
          Describes the color representation for the metric. This is often used to aid clinicians to track and identify parameter types by color. In practice, consider a Patient Monitor that has ECG/HR and Pleth for example; the parameters are displayed in different characteristic colors, such as HR-blue, BP-green, and PR and SpO2- magenta.
        • identifier
          List<Identifier> identifier
          Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID.
        • measurementPeriod
          Timing measurementPeriod
          Describes the measurement repetition time. This is not necessarily the same as the update period. The measurement repetition time can range from milliseconds up to hours. An example for a measurement repetition time in the range of milliseconds is the sampling rate of an ECG. An example for a measurement repetition time in the range of hours is a NIBP that is triggered automatically every hour. The update period may be different than the measurement repetition time, if the device does not update the published observed value with the same frequency as it was measured.
        • operationalStatus
          Enumeration<DeviceMetric.DeviceMetricOperationalStatus> operationalStatus
          Indicates current operational state of the device. For example: On, Off, Standby, etc.
        • parent
          Reference parent
          Describes the link to the Device that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device. An example would be a Device that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location.
        • parentTarget
          Device parentTarget
          The actual object that is the target of the reference (Describes the link to the Device that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device. An example would be a Device that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location.)
        • source
          Reference source
          Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.
        • sourceTarget
          Device sourceTarget
          The actual object that is the target of the reference (Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.)
        • type
          CodeableConcept type
          Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.
        • unit
          CodeableConcept unit
          Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.
    • Class org.hl7.fhir.r4.model.DeviceMetric.DeviceMetricCalibrationComponent

      class DeviceMetricCalibrationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1163986578L
    • Class org.hl7.fhir.r4.model.DeviceMetric.DeviceMetricCalibrationStateEnumFactory

      class DeviceMetricCalibrationStateEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.DeviceMetric.DeviceMetricCalibrationTypeEnumFactory

      class DeviceMetricCalibrationTypeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.DeviceMetric.DeviceMetricCategoryEnumFactory

      class DeviceMetricCategoryEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.DeviceMetric.DeviceMetricColorEnumFactory

      class DeviceMetricColorEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.DeviceMetric.DeviceMetricOperationalStatusEnumFactory

      class DeviceMetricOperationalStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.DeviceRequest

      class DeviceRequest extends DomainResource implements Serializable
      serialVersionUID:
      1484452423L
      • Serialized Fields

        • authoredOn
          DateTimeType authoredOn
          When the request transitioned to being actionable.
        • basedOn
          List<Reference> basedOn
          Plan/proposal/order fulfilled by this request.
        • basedOnTarget
          List<Resource> basedOnTarget
          The actual objects that are the target of the reference (Plan/proposal/order fulfilled by this request.)
        • code
          Type code
          The details of the device to be used.
        • encounter
          Reference encounter
          An encounter that provides additional context in which this request is made.
        • encounterTarget
          Encounter encounterTarget
          The actual object that is the target of the reference (An encounter that provides additional context in which this request is made.)
        • groupIdentifier
          Identifier groupIdentifier
          Composite request this is part of.
        • identifier
          List<Identifier> identifier
          Identifiers assigned to this order by the orderer or by the receiver.
        • instantiatesCanonical
          List<CanonicalType> instantiatesCanonical
          The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.
        • instantiatesUri
          List<UriType> instantiatesUri
          The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.
        • insurance
          List<Reference> insurance
          Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.
        • insuranceTarget
          List<Resource> insuranceTarget
          The actual objects that are the target of the reference (Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.)
        • intent
          Enumeration<DeviceRequest.RequestIntent> intent
          Whether the request is a proposal, plan, an original order or a reflex order.
        • note
          List<Annotation> note
          Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.
        • occurrence
          Type occurrence
          The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".
        • parameter
          List<DeviceRequest.DeviceRequestParameterComponent> parameter
          Specific parameters for the ordered item. For example, the prism value for lenses.
        • performer
          Reference performer
          The desired performer for doing the diagnostic testing.
        • performerTarget
          Resource performerTarget
          The actual object that is the target of the reference (The desired performer for doing the diagnostic testing.)
        • performerType
          CodeableConcept performerType
          Desired type of performer for doing the diagnostic testing.
        • priority
          Enumeration<DeviceRequest.RequestPriority> priority
          Indicates how quickly the {{title}} should be addressed with respect to other requests.
        • priorRequest
          List<Reference> priorRequest
          The request takes the place of the referenced completed or terminated request(s).
        • priorRequestTarget
          List<Resource> priorRequestTarget
          The actual objects that are the target of the reference (The request takes the place of the referenced completed or terminated request(s).)
        • reasonCode
          List<CodeableConcept> reasonCode
          Reason or justification for the use of this device.
        • reasonReference
          List<Reference> reasonReference
          Reason or justification for the use of this device.
        • reasonReferenceTarget
          List<Resource> reasonReferenceTarget
          The actual objects that are the target of the reference (Reason or justification for the use of this device.)
        • relevantHistory
          List<Reference> relevantHistory
          Key events in the history of the request.
        • relevantHistoryTarget
          List<Provenance> relevantHistoryTarget
          The actual objects that are the target of the reference (Key events in the history of the request.)
        • requester
          Reference requester
          The individual who initiated the request and has responsibility for its activation.
        • requesterTarget
          Resource requesterTarget
          The actual object that is the target of the reference (The individual who initiated the request and has responsibility for its activation.)
        • status
          Enumeration<DeviceRequest.DeviceRequestStatus> status
          The status of the request.
        • subject
          Reference subject
          The patient who will use the device.
        • subjectTarget
          Resource subjectTarget
          The actual object that is the target of the reference (The patient who will use the device.)
        • supportingInfo
          List<Reference> supportingInfo
          Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body the device will be used (i.e. the target site).
        • supportingInfoTarget
          List<Resource> supportingInfoTarget
          The actual objects that are the target of the reference (Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body the device will be used (i.e. the target site).)
    • Class org.hl7.fhir.r4.model.DeviceRequest.DeviceRequestParameterComponent

      class DeviceRequestParameterComponent extends BackboneElement implements Serializable
      serialVersionUID:
      884525025L
      • Serialized Fields

        • code
          CodeableConcept code
          A code or string that identifies the device detail being asserted.
        • value
          Type value
          The value of the device detail.
    • Class org.hl7.fhir.r4.model.DeviceRequest.DeviceRequestStatusEnumFactory

      class DeviceRequestStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.DeviceRequest.RequestIntentEnumFactory

      class RequestIntentEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.DeviceRequest.RequestPriorityEnumFactory

      class RequestPriorityEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.DeviceUseStatement

      class DeviceUseStatement extends DomainResource implements Serializable
      serialVersionUID:
      -968330048L
      • Serialized Fields

        • basedOn
          List<Reference> basedOn
          A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement.
        • basedOnTarget
          List<ServiceRequest> basedOnTarget
          The actual objects that are the target of the reference (A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement.)
        • bodySite
          CodeableConcept bodySite
          Indicates the anotomic location on the subject's body where the device was used ( i.e. the target).
        • derivedFrom
          List<Reference> derivedFrom
          Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement.
        • derivedFromTarget
          List<Resource> derivedFromTarget
          The actual objects that are the target of the reference (Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement.)
        • device
          Reference device
          The details of the device used.
        • deviceTarget
          Device deviceTarget
          The actual object that is the target of the reference (The details of the device used.)
        • identifier
          List<Identifier> identifier
          An external identifier for this statement such as an IRI.
        • note
          List<Annotation> note
          Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.
        • reasonCode
          List<CodeableConcept> reasonCode
          Reason or justification for the use of the device.
        • reasonReference
          List<Reference> reasonReference
          Indicates another resource whose existence justifies this DeviceUseStatement.
        • reasonReferenceTarget
          List<Resource> reasonReferenceTarget
          The actual objects that are the target of the reference (Indicates another resource whose existence justifies this DeviceUseStatement.)
        • recordedOn
          DateTimeType recordedOn
          The time at which the statement was made/recorded.
        • source
          Reference source
          Who reported the device was being used by the patient.
        • sourceTarget
          Resource sourceTarget
          The actual object that is the target of the reference (Who reported the device was being used by the patient.)
        • status
          Enumeration<DeviceUseStatement.DeviceUseStatementStatus> status
          A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed.
        • subject
          Reference subject
          The patient who used the device.
        • subjectTarget
          Resource subjectTarget
          The actual object that is the target of the reference (The patient who used the device.)
        • timing
          Type timing
          How often the device was used.
    • Class org.hl7.fhir.r4.model.DeviceUseStatement.DeviceUseStatementStatusEnumFactory

      class DeviceUseStatementStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.DiagnosticReport

      class DiagnosticReport extends DomainResource implements Serializable
      serialVersionUID:
      589102296L
      • Serialized Fields

        • basedOn
          List<Reference> basedOn
          Details concerning a service requested.
        • basedOnTarget
          List<Resource> basedOnTarget
          The actual objects that are the target of the reference (Details concerning a service requested.)
        • category
          List<CodeableConcept> category
          A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.
        • code
          CodeableConcept code
          A code or name that describes this diagnostic report.
        • conclusion
          StringType conclusion
          Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.
        • conclusionCode
          List<CodeableConcept> conclusionCode
          One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.
        • effective
          Type effective
          The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.
        • encounter
          Reference encounter
          The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.
        • encounterTarget
          Encounter encounterTarget
          The actual object that is the target of the reference (The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.)
        • identifier
          List<Identifier> identifier
          Identifiers assigned to this report by the performer or other systems.
        • imagingStudy
          List<Reference> imagingStudy
          One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.
        • imagingStudyTarget
          List<ImagingStudy> imagingStudyTarget
          The actual objects that are the target of the reference (One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.)
        • issued
          InstantType issued
          The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified.
        • media
          List<DiagnosticReport.DiagnosticReportMediaComponent> media
          A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).
        • performer
          List<Reference> performer
          The diagnostic service that is responsible for issuing the report.
        • performerTarget
          List<Resource> performerTarget
          The actual objects that are the target of the reference (The diagnostic service that is responsible for issuing the report.)
        • presentedForm
          List<Attachment> presentedForm
          Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.
        • result
          List<Reference> result
          [Observations](observation.html) that are part of this diagnostic report.
        • resultsInterpreter
          List<Reference> resultsInterpreter
          The practitioner or organization that is responsible for the report's conclusions and interpretations.
        • resultsInterpreterTarget
          List<Resource> resultsInterpreterTarget
          The actual objects that are the target of the reference (The practitioner or organization that is responsible for the report's conclusions and interpretations.)
        • resultTarget
          List<Observation> resultTarget
          The actual objects that are the target of the reference ([Observations](observation.html) that are part of this diagnostic report.)
        • specimen
          List<Reference> specimen
          Details about the specimens on which this diagnostic report is based.
        • specimenTarget
          List<Specimen> specimenTarget
          The actual objects that are the target of the reference (Details about the specimens on which this diagnostic report is based.)
        • status
          Enumeration<DiagnosticReport.DiagnosticReportStatus> status
          The status of the diagnostic report.
        • subject
          Reference subject
          The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.
        • subjectTarget
          Resource subjectTarget
          The actual object that is the target of the reference (The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.)
    • Class org.hl7.fhir.r4.model.DiagnosticReport.DiagnosticReportMediaComponent

      class DiagnosticReportMediaComponent extends BackboneElement implements Serializable
      serialVersionUID:
      935791940L
      • Serialized Fields

        • comment
          StringType comment
          A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features.
        • link
          Reference link
          Reference to the image source.
        • linkTarget
          Media linkTarget
          The actual object that is the target of the reference (Reference to the image source.)
    • Class org.hl7.fhir.r4.model.DiagnosticReport.DiagnosticReportStatusEnumFactory

      class DiagnosticReportStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Distance

      class Distance extends Quantity implements Serializable
      serialVersionUID:
      0L
    • Class org.hl7.fhir.r4.model.DocumentManifest

      class DocumentManifest extends DomainResource implements Serializable
      serialVersionUID:
      432971934L
      • Serialized Fields

        • author
          List<Reference> author
          Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.
        • authorTarget
          List<Resource> authorTarget
          The actual objects that are the target of the reference (Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.)
        • content
          List<Reference> content
          The list of Resources that consist of the parts of this manifest.
        • contentTarget
          List<Resource> contentTarget
          The actual objects that are the target of the reference (The list of Resources that consist of the parts of this manifest.)
        • created
          DateTimeType created
          When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.).
        • description
          StringType description
          Human-readable description of the source document. This is sometimes known as the "title".
        • identifier
          List<Identifier> identifier
          Other identifiers associated with the document manifest, including version independent identifiers.
        • masterIdentifier
          Identifier masterIdentifier
          A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.
        • recipient
          List<Reference> recipient
          A patient, practitioner, or organization for which this set of documents is intended.
        • recipientTarget
          List<Resource> recipientTarget
          The actual objects that are the target of the reference (A patient, practitioner, or organization for which this set of documents is intended.)
        • related
          List<DocumentManifest.DocumentManifestRelatedComponent> related
          Related identifiers or resources associated with the DocumentManifest.
        • source
          UriType source
          Identifies the source system, application, or software that produced the document manifest.
        • status
          Enumeration<Enumerations.DocumentReferenceStatus> status
          The status of this document manifest.
        • subject
          Reference subject
          Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).
        • subjectTarget
          Resource subjectTarget
          The actual object that is the target of the reference (Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).)
        • type
          CodeableConcept type
          The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.
    • Class org.hl7.fhir.r4.model.DocumentManifest.DocumentManifestRelatedComponent

      class DocumentManifestRelatedComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1670123330L
      • Serialized Fields

        • identifier
          Identifier identifier
          Related identifier to this DocumentManifest. For example, Order numbers, accession numbers, XDW workflow numbers.
        • ref
          Reference ref
          Related Resource to this DocumentManifest. For example, Order, ServiceRequest, Procedure, EligibilityRequest, etc.
        • refTarget
          Resource refTarget
          The actual object that is the target of the reference (Related Resource to this DocumentManifest. For example, Order, ServiceRequest, Procedure, EligibilityRequest, etc.)
    • Class org.hl7.fhir.r4.model.DocumentReference

      class DocumentReference extends DomainResource implements Serializable
      serialVersionUID:
      307086535L
      • Serialized Fields

        • authenticator
          Reference authenticator
          Which person or organization authenticates that this document is valid.
        • authenticatorTarget
          Resource authenticatorTarget
          The actual object that is the target of the reference (Which person or organization authenticates that this document is valid.)
        • author
          List<Reference> author
          Identifies who is responsible for adding the information to the document.
        • authorTarget
          List<Resource> authorTarget
          The actual objects that are the target of the reference (Identifies who is responsible for adding the information to the document.)
        • category
          List<CodeableConcept> category
          A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.
        • content
          List<DocumentReference.DocumentReferenceContentComponent> content
          The document and format referenced. There may be multiple content element repetitions, each with a different format.
        • context
          DocumentReference.DocumentReferenceContextComponent context
          The clinical context in which the document was prepared.
        • custodian
          Reference custodian
          Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.
        • custodianTarget
          Organization custodianTarget
          The actual object that is the target of the reference (Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.)
        • date
          InstantType date
          When the document reference was created.
        • description
          StringType description
          Human-readable description of the source document.
        • docStatus
          Enumeration<DocumentReference.ReferredDocumentStatus> docStatus
          The status of the underlying document.
        • identifier
          List<Identifier> identifier
          Other identifiers associated with the document, including version independent identifiers.
        • masterIdentifier
          Identifier masterIdentifier
          Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.
        • relatesTo
          List<DocumentReference.DocumentReferenceRelatesToComponent> relatesTo
          Relationships that this document has with other document references that already exist.
        • securityLabel
          List<CodeableConcept> securityLabel
          A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.
        • status
          Enumeration<Enumerations.DocumentReferenceStatus> status
          The status of this document reference.
        • subject
          Reference subject
          Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).
        • subjectTarget
          Resource subjectTarget
          The actual object that is the target of the reference (Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).)
        • type
          CodeableConcept type
          Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.
    • Class org.hl7.fhir.r4.model.DocumentReference.DocumentReferenceContentComponent

      class DocumentReferenceContentComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1313860217L
      • Serialized Fields

        • attachment
          Attachment attachment
          The document or URL of the document along with critical metadata to prove content has integrity.
        • format
          Coding format
          An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.
    • Class org.hl7.fhir.r4.model.DocumentReference.DocumentReferenceContextComponent

      class DocumentReferenceContextComponent extends BackboneElement implements Serializable
      serialVersionUID:
      140463218L
      • Serialized Fields

        • encounter
          List<Reference> encounter
          Describes the clinical encounter or type of care that the document content is associated with.
        • encounterTarget
          List<Resource> encounterTarget
          The actual objects that are the target of the reference (Describes the clinical encounter or type of care that the document content is associated with.)
        • event
          List<CodeableConcept> event
          This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.
        • facilityType
          CodeableConcept facilityType
          The kind of facility where the patient was seen.
        • period
          Period period
          The time period over which the service that is described by the document was provided.
        • practiceSetting
          CodeableConcept practiceSetting
          This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.
        • related
          List<Reference> related
          Related identifiers or resources associated with the DocumentReference.
        • relatedTarget
          List<Resource> relatedTarget
          The actual objects that are the target of the reference (Related identifiers or resources associated with the DocumentReference.)
        • sourcePatientInfo
          Reference sourcePatientInfo
          The Patient Information as known when the document was published. May be a reference to a version specific, or contained.
        • sourcePatientInfoTarget
          Patient sourcePatientInfoTarget
          The actual object that is the target of the reference (The Patient Information as known when the document was published. May be a reference to a version specific, or contained.)
    • Class org.hl7.fhir.r4.model.DocumentReference.DocumentReferenceRelatesToComponent

      class DocumentReferenceRelatesToComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -347257495L
    • Class org.hl7.fhir.r4.model.DocumentReference.DocumentRelationshipTypeEnumFactory

      class DocumentRelationshipTypeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.DocumentReference.ReferredDocumentStatusEnumFactory

      class ReferredDocumentStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.DomainResource

      class DomainResource extends Resource implements Serializable
      serialVersionUID:
      -970285559L
      • Serialized Fields

        • contained
          List<Resource> contained
          These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
        • extension
          List<Extension> extension
          May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
        • modifierExtension
          List<Extension> modifierExtension
          May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
        • text
          Narrative text
          A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
    • Class org.hl7.fhir.r4.model.Dosage

      class Dosage extends BackboneType implements Serializable
      serialVersionUID:
      -1095063329L
      • Serialized Fields

        • additionalInstruction
          List<CodeableConcept> additionalInstruction
          Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").
        • asNeeded
          Type asNeeded
          Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).
        • doseAndRate
          List<Dosage.DosageDoseAndRateComponent> doseAndRate
          The amount of medication administered.
        • maxDosePerAdministration
          Quantity maxDosePerAdministration
          Upper limit on medication per administration.
        • maxDosePerLifetime
          Quantity maxDosePerLifetime
          Upper limit on medication per lifetime of the patient.
        • maxDosePerPeriod
          Ratio maxDosePerPeriod
          Upper limit on medication per unit of time.
        • method
          CodeableConcept method
          Technique for administering medication.
        • patientInstruction
          StringType patientInstruction
          Instructions in terms that are understood by the patient or consumer.
        • route
          CodeableConcept route
          How drug should enter body.
        • sequence
          IntegerType sequence
          Indicates the order in which the dosage instructions should be applied or interpreted.
        • site
          CodeableConcept site
          Body site to administer to.
        • text
          StringType text
          Free text dosage instructions e.g. SIG.
        • timing
          Timing timing
          When medication should be administered.
    • Class org.hl7.fhir.r4.model.Dosage.DosageDoseAndRateComponent

      class DosageDoseAndRateComponent extends Element implements Serializable
      serialVersionUID:
      -2133698888L
      • Serialized Fields

        • dose
          Type dose
          Amount of medication per dose.
        • rate
          Type rate
          Amount of medication per unit of time.
        • type
          CodeableConcept type
          The kind of dose or rate specified, for example, ordered or calculated.
    • Class org.hl7.fhir.r4.model.Duration

      class Duration extends Quantity implements Serializable
      serialVersionUID:
      0L
    • Class org.hl7.fhir.r4.model.EffectEvidenceSynthesis

      class EffectEvidenceSynthesis extends MetadataResource implements Serializable
      serialVersionUID:
      23150467L
      • Serialized Fields

        • approvalDate
          DateType approvalDate
          The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
        • author
          List<ContactDetail> author
          An individiual or organization primarily involved in the creation and maintenance of the content.
        • certainty
          List<EffectEvidenceSynthesis.EffectEvidenceSynthesisCertaintyComponent> certainty
          A description of the certainty of the effect estimate.
        • copyright
          MarkdownType copyright
          A copyright statement relating to the effect evidence synthesis and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the effect evidence synthesis.
        • editor
          List<ContactDetail> editor
          An individual or organization primarily responsible for internal coherence of the content.
        • effectEstimate
          List<EffectEvidenceSynthesis.EffectEvidenceSynthesisEffectEstimateComponent> effectEstimate
          The estimated effect of the exposure variant.
        • effectivePeriod
          Period effectivePeriod
          The period during which the effect evidence synthesis content was or is planned to be in active use.
        • endorser
          List<ContactDetail> endorser
          An individual or organization responsible for officially endorsing the content for use in some setting.
        • exposure
          Reference exposure
          A reference to a EvidenceVariable resource that defines the exposure for the research.
        • exposureAlternative
          Reference exposureAlternative
          A reference to a EvidenceVariable resource that defines the comparison exposure for the research.
        • exposureAlternativeTarget
          EvidenceVariable exposureAlternativeTarget
          The actual object that is the target of the reference (A reference to a EvidenceVariable resource that defines the comparison exposure for the research.)
        • exposureTarget
          EvidenceVariable exposureTarget
          The actual object that is the target of the reference (A reference to a EvidenceVariable resource that defines the exposure for the research.)
        • identifier
          List<Identifier> identifier
          A formal identifier that is used to identify this effect evidence synthesis when it is represented in other formats, or referenced in a specification, model, design or an instance.
        • lastReviewDate
          DateType lastReviewDate
          The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
        • note
          List<Annotation> note
          A human-readable string to clarify or explain concepts about the resource.
        • outcome
          Reference outcome
          A reference to a EvidenceVariable resomece that defines the outcome for the research.
        • outcomeTarget
          EvidenceVariable outcomeTarget
          The actual object that is the target of the reference (A reference to a EvidenceVariable resomece that defines the outcome for the research.)
        • population
          Reference population
          A reference to a EvidenceVariable resource that defines the population for the research.
        • populationTarget
          EvidenceVariable populationTarget
          The actual object that is the target of the reference (A reference to a EvidenceVariable resource that defines the population for the research.)
        • relatedArtifact
          List<RelatedArtifact> relatedArtifact
          Related artifacts such as additional documentation, justification, or bibliographic references.
        • resultsByExposure
          List<EffectEvidenceSynthesis.EffectEvidenceSynthesisResultsByExposureComponent> resultsByExposure
          A description of the results for each exposure considered in the effect estimate.
        • reviewer
          List<ContactDetail> reviewer
          An individual or organization primarily responsible for review of some aspect of the content.
        • sampleSize
          EffectEvidenceSynthesis.EffectEvidenceSynthesisSampleSizeComponent sampleSize
          A description of the size of the sample involved in the synthesis.
        • studyType
          CodeableConcept studyType
          Type of study eg randomized trial.
        • synthesisType
          CodeableConcept synthesisType
          Type of synthesis eg meta-analysis.
        • topic
          List<CodeableConcept> topic
          Descriptive topics related to the content of the EffectEvidenceSynthesis. Topics provide a high-level categorization grouping types of EffectEvidenceSynthesiss that can be useful for filtering and searching.
    • Class org.hl7.fhir.r4.model.EffectEvidenceSynthesis.EffectEvidenceSynthesisCertaintyCertaintySubcomponentComponent

      class EffectEvidenceSynthesisCertaintyCertaintySubcomponentComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -411994816L
      • Serialized Fields

        • note
          List<Annotation> note
          A human-readable string to clarify or explain concepts about the resource.
        • rating
          List<CodeableConcept> rating
          A rating of a subcomponent of rating certainty.
        • type
          CodeableConcept type
          Type of subcomponent of certainty rating.
    • Class org.hl7.fhir.r4.model.EffectEvidenceSynthesis.EffectEvidenceSynthesisCertaintyComponent

      class EffectEvidenceSynthesisCertaintyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      647101417L
    • Class org.hl7.fhir.r4.model.EffectEvidenceSynthesis.EffectEvidenceSynthesisEffectEstimateComponent

      class EffectEvidenceSynthesisEffectEstimateComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1075065083L
    • Class org.hl7.fhir.r4.model.EffectEvidenceSynthesis.EffectEvidenceSynthesisEffectEstimatePrecisionEstimateComponent

      class EffectEvidenceSynthesisEffectEstimatePrecisionEstimateComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -110178057L
      • Serialized Fields

        • from
          DecimalType from
          Lower bound of confidence interval.
        • level
          DecimalType level
          Use 95 for a 95% confidence interval.
        • to
          DecimalType to
          Upper bound of confidence interval.
        • type
          CodeableConcept type
          Examples include confidence interval and interquartile range.
    • Class org.hl7.fhir.r4.model.EffectEvidenceSynthesis.EffectEvidenceSynthesisResultsByExposureComponent

      class EffectEvidenceSynthesisResultsByExposureComponent extends BackboneElement implements Serializable
      serialVersionUID:
      144886133L
      • Serialized Fields

        • description
          StringType description
          Human-readable summary of results by exposure state.
        • exposureState
          Enumeration<EffectEvidenceSynthesis.ExposureState> exposureState
          Whether these results are for the exposure state or alternative exposure state.
        • riskEvidenceSynthesis
          Reference riskEvidenceSynthesis
          Reference to a RiskEvidenceSynthesis resource.
        • riskEvidenceSynthesisTarget
          RiskEvidenceSynthesis riskEvidenceSynthesisTarget
          The actual object that is the target of the reference (Reference to a RiskEvidenceSynthesis resource.)
        • variantState
          CodeableConcept variantState
          Used to define variant exposure states such as low-risk state.
    • Class org.hl7.fhir.r4.model.EffectEvidenceSynthesis.EffectEvidenceSynthesisSampleSizeComponent

      class EffectEvidenceSynthesisSampleSizeComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1116074476L
      • Serialized Fields

        • description
          StringType description
          Human-readable summary of sample size.
        • numberOfParticipants
          IntegerType numberOfParticipants
          Number of participants included in this evidence synthesis.
        • numberOfStudies
          IntegerType numberOfStudies
          Number of studies included in this evidence synthesis.
    • Class org.hl7.fhir.r4.model.EffectEvidenceSynthesis.ExposureStateEnumFactory

      class ExposureStateEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Element

      class Element extends Base implements Serializable
      serialVersionUID:
      -1452745816L
      • Serialized Fields

        • disallowExtensions
          boolean disallowExtensions
          This is used in the FHIRPath engine to record that no extensions are allowed for this item in the context in which it is used. todo: enforce this....
        • extension
          List<Extension> extension
          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
        • id
          StringType id
          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
    • Class org.hl7.fhir.r4.model.ElementDefinition

      class ElementDefinition extends BackboneType implements Serializable
      serialVersionUID:
      1482114790L
      • Serialized Fields

        • alias
          List<StringType> alias
          Identifies additional names by which this element might also be known.
        • base
          ElementDefinition.ElementDefinitionBaseComponent base
          Information about the base definition of the element, provided to make it unnecessary for tools to trace the deviation of the element through the derived and related profiles. When the element definition is not the original definition of an element - i.g. either in a constraint on another type, or for elements from a super type in a snap shot - then the information in provided in the element definition may be different to the base definition. On the original definition of the element, it will be same.
        • binding
          ElementDefinition.ElementDefinitionBindingComponent binding
          Binds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri).
        • code
          List<Coding> code
          A code that has the same meaning as the element in a particular terminology.
        • comment
          MarkdownType comment
          Explanatory notes and implementation guidance about the data element, including notes about how to use the data properly, exceptions to proper use, etc. (Note: The text you are reading is specified in ElementDefinition.comment).
        • condition
          List<IdType> condition
          A reference to an invariant that may make additional statements about the cardinality or value in the instance.
        • constraint
          List<ElementDefinition.ElementDefinitionConstraintComponent> constraint
          Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.
        • contentReference
          UriType contentReference
          Identifies an element defined elsewhere in the definition whose content rules should be applied to the current element. ContentReferences bring across all the rules that are in the ElementDefinition for the element, including definitions, cardinality constraints, bindings, invariants etc.
        • defaultValue
          Type defaultValue
          The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').
        • definition
          MarkdownType definition
          Provides a complete explanation of the meaning of the data element for human readability. For the case of elements derived from existing elements (e.g. constraints), the definition SHALL be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resource. (Note: The text you are reading is specified in ElementDefinition.definition).
        • example
          List<ElementDefinition.ElementDefinitionExampleComponent> example
          A sample value for this element demonstrating the type of information that would typically be found in the element.
        • fixed
          Type fixed
          Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
        • isModifier
          BooleanType isModifier
          If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they SHALL either recognize the element and process it, and/or a pre-determination has been made that it is not relevant to their particular system.
        • isModifierReason
          StringType isModifierReason
          Explains how that element affects the interpretation of the resource or element that contains it.
        • isSummary
          BooleanType isSummary
          Whether the element should be included if a client requests a search with the parameter _summary=true.
        • label
          StringType label
          A single preferred label which is the text to display beside the element indicating its meaning or to use to prompt for the element in a user display or form.
        • mapping
          List<ElementDefinition.ElementDefinitionMappingComponent> mapping
          Identifies a concept from an external specification that roughly corresponds to this element.
        • max
          StringType max
          The maximum number of times this element is permitted to appear in the instance.
        • maxLength
          IntegerType maxLength
          Indicates the maximum length in characters that is permitted to be present in conformant instances and which is expected to be supported by conformant consumers that support the element.
        • maxValue
          Type maxValue
          The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
        • meaningWhenMissing
          MarkdownType meaningWhenMissing
          The Implicit meaning that is to be understood when this element is missing (e.g. 'when this element is missing, the period is ongoing').
        • min
          UnsignedIntType min
          The minimum number of times this element SHALL appear in the instance.
        • minValue
          Type minValue
          The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
        • mustSupport
          BooleanType mustSupport
          If true, implementations that produce or consume resources SHALL provide "support" for the element in some meaningful way. If false, the element may be ignored and not supported. If false, whether to populate or use the data element in any way is at the discretion of the implementation.
        • orderMeaning
          StringType orderMeaning
          If present, indicates that the order of the repeating element has meaning and describes what that meaning is. If absent, it means that the order of the element has no meaning.
        • path
          StringType path
          The path identifies the element and is expressed as a "."-separated list of ancestor elements, beginning with the name of the resource or extension.
        • pattern
          Type pattern
          Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value.
        • representation
          List<Enumeration<ElementDefinition.PropertyRepresentation>> representation
          Codes that define how this element is represented in instances, when the deviation varies from the normal case.
        • requirements
          MarkdownType requirements
          This element is for traceability of why the element was created and why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this element.
        • short_
          StringType short_
          A concise description of what this element means (e.g. for use in autogenerated summaries).
        • sliceIsConstraining
          BooleanType sliceIsConstraining
          If true, indicates that this slice definition is constraining a slice definition with the same name in an inherited profile. If false, the slice is not overriding any slice in an inherited profile. If missing, the slice might or might not be overriding a slice in an inherited profile, depending on the sliceName.
        • sliceName
          StringType sliceName
          The name of this element definition slice, when slicing is working. The name must be a token with no dots or spaces. This is a unique name referring to a specific set of constraints applied to this element, used to provide a name to different slices of the same element.
        • slicing
          ElementDefinition.ElementDefinitionSlicingComponent slicing
          Indicates that the element is sliced into a set of alternative definitions (i.e. in a structure definition, there are multiple different constraints on a single element in the base resource). Slicing can be used in any resource that has cardinality ..* on the base resource, or any resource with a choice of types. The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set).
        • type
          List<ElementDefinition.TypeRefComponent> type
          The data type or resource that the value of this element is permitted to be.
    • Class org.hl7.fhir.r4.model.ElementDefinition.AggregationModeEnumFactory

      class AggregationModeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.ElementDefinition.ConstraintSeverityEnumFactory

      class ConstraintSeverityEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.ElementDefinition.DiscriminatorTypeEnumFactory

      class DiscriminatorTypeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.ElementDefinition.ElementDefinitionBaseComponent

      class ElementDefinitionBaseComponent extends Element implements Serializable
      serialVersionUID:
      -1412704221L
      • Serialized Fields

        • max
          StringType max
          Maximum cardinality of the base element identified by the path.
        • min
          UnsignedIntType min
          Minimum cardinality of the base element identified by the path.
        • path
          StringType path
          The Path that identifies the base element - this matches the ElementDefinition.path for that element. Across FHIR, there is only one base definition of any element - that is, an element definition on a [[[StructureDefinition]]] without a StructureDefinition.base.
    • Class org.hl7.fhir.r4.model.ElementDefinition.ElementDefinitionBindingComponent

      class ElementDefinitionBindingComponent extends Element implements Serializable
      serialVersionUID:
      -514477030L
      • Serialized Fields

        • description
          StringType description
          Describes the intended use of this particular set of codes.
        • strength
          Enumeration<Enumerations.BindingStrength> strength
          Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.
        • valueSet
          CanonicalType valueSet
          Refers to the value set that identifies the set of codes the binding refers to.
    • Class org.hl7.fhir.r4.model.ElementDefinition.ElementDefinitionConstraintComponent

      class ElementDefinitionConstraintComponent extends Element implements Serializable
      serialVersionUID:
      1048354565L
      • Serialized Fields

        • expression
          StringType expression
          A [FHIRPath](fhirpath.html) expression of constraint that can be executed to see if this constraint is met.
        • human
          StringType human
          Text that can be used to describe the constraint in messages identifying that the constraint has been violated.
        • key
          IdType key
          Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.
        • requirements
          StringType requirements
          Description of why this constraint is necessary or appropriate.
        • severity
          Enumeration<ElementDefinition.ConstraintSeverity> severity
          Identifies the impact constraint violation has on the conformance of the instance.
        • source
          CanonicalType source
          A reference to the original source of the constraint, for traceability purposes.
        • xpath
          StringType xpath
          An XPath expression of constraint that can be executed to see if this constraint is met.
    • Class org.hl7.fhir.r4.model.ElementDefinition.ElementDefinitionExampleComponent

      class ElementDefinitionExampleComponent extends Element implements Serializable
      serialVersionUID:
      457572481L
      • Serialized Fields

        • label
          StringType label
          Describes the purpose of this example amoung the set of examples.
        • value
          Type value
          The actual value for the element, which must be one of the types allowed for this element.
    • Class org.hl7.fhir.r4.model.ElementDefinition.ElementDefinitionMappingComponent

      class ElementDefinitionMappingComponent extends Element implements Serializable
      serialVersionUID:
      1386816887L
      • Serialized Fields

        • comment
          StringType comment
          Comments that provide information about the mapping or its use.
        • identity
          IdType identity
          An internal reference to the definition of a mapping.
        • language
          CodeType language
          Identifies the computable language in which mapping.map is expressed.
        • map
          StringType map
          Expresses what part of the target specification corresponds to this element.
    • Class org.hl7.fhir.r4.model.ElementDefinition.ElementDefinitionSlicingComponent

      class ElementDefinitionSlicingComponent extends Element implements Serializable
      serialVersionUID:
      -311635839L
      • Serialized Fields

        • description
          StringType description
          A human-readable text description of how the slicing works. If there is no discriminator, this is required to be present to provide whatever information is possible about how the slices can be differentiated.
        • discriminator
          List<ElementDefinition.ElementDefinitionSlicingDiscriminatorComponent> discriminator
          Designates which child elements are used to discriminate between the slices when processing an instance. If one or more discriminators are provided, the value of the child elements in the instance data SHALL completely distinguish which slice the element in the resource matches based on the allowed values for those elements in each of the slices.
        • ordered
          BooleanType ordered
          If the matching elements have to occur in the same order as defined in the profile.
        • rules
          Enumeration<ElementDefinition.SlicingRules> rules
          Whether additional slices are allowed or not. When the slices are ordered, profile authors can also say that additional slices are only allowed at the end.
    • Class org.hl7.fhir.r4.model.ElementDefinition.ElementDefinitionSlicingDiscriminatorComponent

      class ElementDefinitionSlicingDiscriminatorComponent extends Element implements Serializable
      serialVersionUID:
      1151159293L
      • Serialized Fields

        • path
          StringType path
          A FHIRPath expression, using [the simple subset of FHIRPath](fhirpath.html#simple), that is used to identify the element on which discrimination is based.
        • type
          Enumeration<ElementDefinition.DiscriminatorType> type
          How the element value is interpreted when discrimination is evaluated.
    • Class org.hl7.fhir.r4.model.ElementDefinition.PropertyRepresentationEnumFactory

      class PropertyRepresentationEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.ElementDefinition.ReferenceVersionRulesEnumFactory

      class ReferenceVersionRulesEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.ElementDefinition.SlicingRulesEnumFactory

      class SlicingRulesEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.ElementDefinition.TypeRefComponent

      class TypeRefComponent extends Element implements Serializable
      serialVersionUID:
      957891653L
      • Serialized Fields

        • aggregation
          List<Enumeration<ElementDefinition.AggregationMode>> aggregation
          If the type is a reference to another resource, how the resource is or can be aggregated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.
        • code
          UriType code
          URL of Data type or Resource that is a(or the) type used for this element. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. "string" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.
        • profile
          List<CanonicalType> profile
          Identifies a profile structure or implementation Guide that applies to the datatype this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the type SHALL conform to at least one profile defined in the implementation guide.
        • targetProfile
          List<CanonicalType> targetProfile
          Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.
        • versioning
          Enumeration<ElementDefinition.ReferenceVersionRules> versioning
          Whether this reference needs to be version specific or version independent, or whether either can be used.
    • Class org.hl7.fhir.r4.model.Encounter

      class Encounter extends DomainResource implements Serializable
      serialVersionUID:
      1358318037L
      • Serialized Fields

        • account
          List<Reference> account
          The set of accounts that may be used for billing for this Encounter.
        • accountTarget
          List<Account> accountTarget
          The actual objects that are the target of the reference (The set of accounts that may be used for billing for this Encounter.)
        • appointment
          List<Reference> appointment
          The appointment that scheduled this encounter.
        • appointmentTarget
          List<Appointment> appointmentTarget
          The actual objects that are the target of the reference (The appointment that scheduled this encounter.)
        • basedOn
          List<Reference> basedOn
          The request this encounter satisfies (e.g. incoming referral or procedure request).
        • basedOnTarget
          List<ServiceRequest> basedOnTarget
          The actual objects that are the target of the reference (The request this encounter satisfies (e.g. incoming referral or procedure request).)
        • class_
          Coding class_
          Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
        • classHistory
          List<Encounter.ClassHistoryComponent> classHistory
          The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.
        • diagnosis
          List<Encounter.DiagnosisComponent> diagnosis
          The list of diagnosis relevant to this encounter.
        • episodeOfCare
          List<Reference> episodeOfCare
          Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).
        • episodeOfCareTarget
          List<EpisodeOfCare> episodeOfCareTarget
          The actual objects that are the target of the reference (Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).)
        • hospitalization
          Encounter.EncounterHospitalizationComponent hospitalization
          Details about the admission to a healthcare service.
        • identifier
          List<Identifier> identifier
          Identifier(s) by which this encounter is known.
        • length
          Duration length
          Quantity of time the encounter lasted. This excludes the time during leaves of absence.
        • location
          List<Encounter.EncounterLocationComponent> location
          List of locations where the patient has been during this encounter.
        • participant
          List<Encounter.EncounterParticipantComponent> participant
          The list of people responsible for providing the service.
        • partOf
          Reference partOf
          Another Encounter of which this encounter is a part of (administratively or in time).
        • partOfTarget
          Encounter partOfTarget
          The actual object that is the target of the reference (Another Encounter of which this encounter is a part of (administratively or in time).)
        • period
          Period period
          The start and end time of the encounter.
        • priority
          CodeableConcept priority
          Indicates the urgency of the encounter.
        • reasonCode
          List<CodeableConcept> reasonCode
          Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
        • reasonReference
          List<Reference> reasonReference
          Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
        • reasonReferenceTarget
          List<Resource> reasonReferenceTarget
          The actual objects that are the target of the reference (Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.)
        • serviceProvider
          Reference serviceProvider
          The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.
        • serviceProviderTarget
          Organization serviceProviderTarget
          The actual object that is the target of the reference (The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.)
        • serviceType
          CodeableConcept serviceType
          Broad categorization of the service that is to be provided (e.g. cardiology).
        • status
          Enumeration<Encounter.EncounterStatus> status
          planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
        • statusHistory
          List<Encounter.StatusHistoryComponent> statusHistory
          The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.
        • subject
          Reference subject
          The patient or group present at the encounter.
        • subjectTarget
          Resource subjectTarget
          The actual object that is the target of the reference (The patient or group present at the encounter.)
        • type
          List<CodeableConcept> type
          Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
    • Class org.hl7.fhir.r4.model.Encounter.ClassHistoryComponent

      class ClassHistoryComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1331020311L
      • Serialized Fields

        • class_
          Coding class_
          inpatient | outpatient | ambulatory | emergency +.
        • period
          Period period
          The time that the episode was in the specified class.
    • Class org.hl7.fhir.r4.model.Encounter.DiagnosisComponent

      class DiagnosisComponent extends BackboneElement implements Serializable
      serialVersionUID:
      128213376L
      • Serialized Fields

        • condition
          Reference condition
          Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
        • conditionTarget
          Resource conditionTarget
          The actual object that is the target of the reference (Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.)
        • rank
          PositiveIntType rank
          Ranking of the diagnosis (for each role type).
        • use
          CodeableConcept use
          Role that this diagnosis has within the encounter (e.g. admission, billing, discharge ?).
    • Class org.hl7.fhir.r4.model.Encounter.EncounterHospitalizationComponent

      class EncounterHospitalizationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1350555270L
      • Serialized Fields

        • admitSource
          CodeableConcept admitSource
          From where patient was admitted (physician referral, transfer).
        • destination
          Reference destination
          Location/organization to which the patient is discharged.
        • destinationTarget
          Resource destinationTarget
          The actual object that is the target of the reference (Location/organization to which the patient is discharged.)
        • dietPreference
          List<CodeableConcept> dietPreference
          Diet preferences reported by the patient.
        • dischargeDisposition
          CodeableConcept dischargeDisposition
          Category or kind of location after discharge.
        • origin
          Reference origin
          The location/organization from which the patient came before admission.
        • originTarget
          Resource originTarget
          The actual object that is the target of the reference (The location/organization from which the patient came before admission.)
        • preAdmissionIdentifier
          Identifier preAdmissionIdentifier
          Pre-admission identifier.
        • reAdmission
          CodeableConcept reAdmission
          Whether this hospitalization is a readmission and why if known.
        • specialArrangement
          List<CodeableConcept> specialArrangement
          Any special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things.
        • specialCourtesy
          List<CodeableConcept> specialCourtesy
          Special courtesies (VIP, board member).
    • Class org.hl7.fhir.r4.model.Encounter.EncounterLocationComponent

      class EncounterLocationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -755081862L
      • Serialized Fields

        • location
          Reference location
          The location where the encounter takes place.
        • locationTarget
          Location locationTarget
          The actual object that is the target of the reference (The location where the encounter takes place.)
        • period
          Period period
          Time period during which the patient was present at the location.
        • physicalType
          CodeableConcept physicalType
          This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query.
        • status
          Enumeration<Encounter.EncounterLocationStatus> status
          The status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time.
    • Class org.hl7.fhir.r4.model.Encounter.EncounterLocationStatusEnumFactory

      class EncounterLocationStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Encounter.EncounterParticipantComponent

      class EncounterParticipantComponent extends BackboneElement implements Serializable
      serialVersionUID:
      317095765L
      • Serialized Fields

        • individual
          Reference individual
          Persons involved in the encounter other than the patient.
        • individualTarget
          Resource individualTarget
          The actual object that is the target of the reference (Persons involved in the encounter other than the patient.)
        • period
          Period period
          The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.
        • type
          List<CodeableConcept> type
          Role of participant in encounter.
    • Class org.hl7.fhir.r4.model.Encounter.EncounterStatusEnumFactory

      class EncounterStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.Encounter.StatusHistoryComponent

      class StatusHistoryComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1893906736L
      • Serialized Fields

    • Class org.hl7.fhir.r4.model.Endpoint

      class Endpoint extends DomainResource implements Serializable
      serialVersionUID:
      755181080L
      • Serialized Fields

        • address
          UrlType address
          The uri that describes the actual end-point to connect to.
        • connectionType
          Coding connectionType
          A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).
        • contact
          List<ContactPoint> contact
          Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
        • header
          List<StringType> header
          Additional headers / information to send as part of the notification.
        • identifier
          List<Identifier> identifier
          Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
        • managingOrganization
          Reference managingOrganization
          The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).
        • managingOrganizationTarget
          Organization managingOrganizationTarget
          The actual object that is the target of the reference (The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).)
        • name
          StringType name
          A friendly name that this endpoint can be referred to with.
        • payloadMimeType
          List<CodeType> payloadMimeType
          The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).
        • payloadType
          List<CodeableConcept> payloadType
          The payload type describes the acceptable content that can be communicated on the endpoint.
        • period
          Period period
          The interval during which the endpoint is expected to be operational.
        • status
          Enumeration<Endpoint.EndpointStatus> status
          active | suspended | error | off | test.
    • Class org.hl7.fhir.r4.model.Endpoint.EndpointStatusEnumFactory

      class EndpointStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.EnrollmentRequest

      class EnrollmentRequest extends DomainResource implements Serializable
      serialVersionUID:
      631501951L
      • Serialized Fields

        • candidate
          Reference candidate
          Patient Resource.
        • candidateTarget
          Patient candidateTarget
          The actual object that is the target of the reference (Patient Resource.)
        • coverage
          Reference coverage
          Reference to the program or plan identification, underwriter or payor.
        • coverageTarget
          Coverage coverageTarget
          The actual object that is the target of the reference (Reference to the program or plan identification, underwriter or payor.)
        • created
          DateTimeType created
          The date when this resource was created.
        • identifier
          List<Identifier> identifier
          The Response business identifier.
        • insurer
          Reference insurer
          The Insurer who is target of the request.
        • insurerTarget
          Organization insurerTarget
          The actual object that is the target of the reference (The Insurer who is target of the request.)
        • provider
          Reference provider
          The practitioner who is responsible for the services rendered to the patient.
        • providerTarget
          Resource providerTarget
          The actual object that is the target of the reference (The practitioner who is responsible for the services rendered to the patient.)
        • status
          Enumeration<EnrollmentRequest.EnrollmentRequestStatus> status
          The status of the resource instance.
    • Class org.hl7.fhir.r4.model.EnrollmentRequest.EnrollmentRequestStatusEnumFactory

      class EnrollmentRequestStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r4.model.EnrollmentResponse

      class EnrollmentResponse extends DomainResource implements Serializable
      serialVersionUID:
      -1759921458L
      • Serialized Fields

        • created
          DateTimeType created
          The date when the enclosed suite of services were performed or completed.
        • disposition
          StringType disposition
          A description of the status of the adjudication.
        • identifier
          List<Identifier> identifier
          The Response business identifier.
        • organization
          Reference organization
          The Insurer who produced this adjudicated response.
        • organizationTarget
          Organization organizationTarget
          The actual object that is the target of the reference (The Insurer who produced this adjudicated response.)
        • outcome
          Enumeration<Enumerations.RemittanceOutcome> outcome
          Processing status: error, complete.
        • request
          Reference request
          Original request resource reference.
        • requestProvider
          Reference requestProvider
          The practitioner who is responsible for the services rendered to the patient.
        • requestProviderTarget
          Resource requestProviderTarget
          The actual object that is the target of the reference (The practitioner who is responsible for the services rendered to the patient.)
        • requestTarget
          EnrollmentRequest requestTarget
          The actual object that is the target of the reference (Original request resource reference.)
        • status