Serialized Form

  • Package org.hl7.fhir.r5.elementmodel

  • Package org.hl7.fhir.r5.model

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

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

        • billingStatus
          CodeableConcept billingStatus
          The BillingStatus tracks the lifecycle of the account through the billing process. It indicates how transactions are treated when they are allocated to the account.
        • 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.
        • partOf
          Reference partOf
          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.
        • type
          CodeableConcept type
          Categorizes the account for reporting and searching purposes.
    • Class org.hl7.fhir.r5.model.Account.AccountStatusEnumFactory

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

      class CoverageComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1695665065L
      • 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.
        • priority
          PositiveIntType priority
          The priority of the coverage in the context of this account.
    • Class org.hl7.fhir.r5.model.Account.GuarantorComponent

      class GuarantorComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -523056773L
      • 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.
        • period
          Period period
          The timeframe during which the guarantor accepts responsibility for the account.
    • Class org.hl7.fhir.r5.model.ActivityDefinition

      class ActivityDefinition extends MetadataResource implements Serializable
      serialVersionUID:
      173439425L
      • 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.
        • contact
          List<ContactDetail> contact
          Contact details to assist a user in finding and communicating with the publisher.
        • 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.
        • date
          DateTimeType date
          The date (and optionally time) when the activity definition 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 activity definition changes.
        • description
          MarkdownType description
          A free text natural language description of the activity definition from a consumer's perspective.
        • 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.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        • 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<Enumerations.RequestIntent> intent
          Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.
        • jurisdiction
          List<CodeableConcept> jurisdiction
          A legal or geographic region in which the activity definition is intended to be used.
        • kind
          Enumeration<ActivityDefinition.RequestResourceType> 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
          CodeableReference location
          Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
        • name
          StringType name
          A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • observationRequirement
          List<Reference> observationRequirement
          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.
        • participant
          List<ActivityDefinition.ActivityDefinitionParticipantComponent> participant
          Indicates who should participate in performing the action described.
        • priority
          Enumeration<Enumerations.RequestPriority> priority
          Indicates how quickly the activity should be addressed with respect to other requests.
        • product
          DataType 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.
        • publisher
          StringType publisher
          The name of the organization or individual that published the activity definition.
        • 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.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this activity definition. Enables tracking the life-cycle of the content.
        • subject
          DataType subject
          A code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.
        • subtitle
          StringType subtitle
          An explanatory or alternate title for the activity definition giving additional information about its content.
        • timing
          DataType timing
          The timing or frequency upon which the described activity is to occur.
        • title
          StringType title
          A short, descriptive, user-friendly title for the activity definition.
        • 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.
        • url
          UriType url
          An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.
        • usage
          StringType usage
          A detailed description of how the activity definition is used from a clinical perspective.
        • useContext
          List<UsageContext> useContext
          The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate activity definition instances.
        • version
          StringType version
          The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.
    • Class org.hl7.fhir.r5.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.r5.model.ActivityDefinition.ActivityDefinitionParticipantComponent

      class ActivityDefinitionParticipantComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -136836616L
    • Class org.hl7.fhir.r5.model.ActivityDefinition.RequestResourceTypeEnumFactory

      class RequestResourceTypeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.Address

      class Address extends DataType 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.r5.model.Address.AddressTypeEnumFactory

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

      class AddressUseEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.AdministrableProductDefinition

      class AdministrableProductDefinition extends DomainResource implements Serializable
      serialVersionUID:
      1447528370L
      • Serialized Fields

        • administrableDoseForm
          CodeableConcept administrableDoseForm
          The dose form of the final product after necessary reconstitution or processing. Contrasts to the manufactured dose form (see ManufacturedItemDefinition). If the manufactured form was 'powder for solution for injection', the administrable dose form could be 'solution for injection' (once mixed with another item having manufactured form 'solvent for solution for injection').
        • device
          Reference device
          A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product. This is not intended for devices that are just co-packaged.
        • formOf
          List<Reference> formOf
          The medicinal product that this is a prepared administrable form of. This element is not a reference to the item(s) that make up this administrable form (for which see AdministrableProductDefinition.producedFrom). It is medicinal product as a whole, which may have several components (as well as packaging, devices etc.), that are given to the patient in this final administrable form. A single medicinal product may have several different administrable products (e.g. a tablet and a cream), and these could have different administrable forms (e.g. tablet as oral solid, or tablet crushed).
        • identifier
          List<Identifier> identifier
          An identifier for the administrable product.
        • ingredient
          List<CodeableConcept> ingredient
          The ingredients of this administrable medicinal product. This is only needed if the ingredients are not specified either using ManufacturedItemDefiniton (via AdministrableProductDefinition.producedFrom) to state which component items are used to make this, or using by incoming references from the Ingredient resource, to state in detail which substances exist within this. This element allows a basic coded ingredient to be used.
        • producedFrom
          List<Reference> producedFrom
          The constituent manufactured item(s) that this administrable product is produced from. Either a single item, or several that are mixed before administration (e.g. a power item and a solvent item, to make a consumable solution). Note the items this is produced from are not raw ingredients (see AdministrableProductDefinition.ingredient), but manufactured medication items (ManufacturedItemDefinitions), which may be combined or prepared and transformed for patient use. The constituent items that this administrable form is produced from are all part of the product (for which see AdministrableProductDefinition.formOf).
        • property
          List<AdministrableProductDefinition.AdministrableProductDefinitionPropertyComponent> property
          Characteristics e.g. a products onset of action.
        • routeOfAdministration
          List<AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent> routeOfAdministration
          The path by which the product is taken into or makes contact with the body. In some regions this is referred to as the licenced or approved route.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this administrable product. Enables tracking the life-cycle of the content.
        • unitOfPresentation
          CodeableConcept unitOfPresentation
          The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' (as in 'contains 100 mcg per puff'), or for a liquid - 'vial' (as in 'contains 5 ml per vial').
    • Class org.hl7.fhir.r5.model.AdministrableProductDefinition.AdministrableProductDefinitionPropertyComponent

      class AdministrableProductDefinitionPropertyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -872048207L
      • Serialized Fields

        • status
          CodeableConcept status
          The status of characteristic e.g. assigned or pending.
        • type
          CodeableConcept type
          A code expressing the type of characteristic.
        • value
          DataType value
          A value for the characteristic.
    • Class org.hl7.fhir.r5.model.AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent

      class AdministrableProductDefinitionRouteOfAdministrationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      322274730L
      • Serialized Fields

        • code
          CodeableConcept code
          Coded expression for the route.
        • firstDose
          Quantity firstDose
          The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement.
        • maxDosePerDay
          Quantity maxDosePerDay
          The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered.
        • maxDosePerTreatmentPeriod
          Ratio maxDosePerTreatmentPeriod
          The maximum dose per treatment period that can be administered.
        • maxSingleDose
          Quantity maxSingleDose
          The maximum single dose that can be administered, can be specified using a numerical value and its unit of measurement.
        • maxTreatmentPeriod
          Duration maxTreatmentPeriod
          The maximum treatment period during which an Investigational Medicinal Product can be administered.
        • targetSpecies
          List<AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesComponent> targetSpecies
          A species for which this route applies.
    • Class org.hl7.fhir.r5.model.AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesComponent

      class AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -560311351L
    • Class org.hl7.fhir.r5.model.AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesWithdrawalPeriodComponent

      class AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesWithdrawalPeriodComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1113691238L
      • Serialized Fields

        • supportingInformation
          StringType supportingInformation
          Extra information about the withdrawal period.
        • tissue
          CodeableConcept tissue
          Coded expression for the type of tissue for which the withdrawal period applues, e.g. meat, milk.
        • value
          Quantity value
          A value for the time.
    • Class org.hl7.fhir.r5.model.AdverseEvent

      class AdverseEvent extends DomainResource implements Serializable
      serialVersionUID:
      1528004510L
      • 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.
        • code
          CodeableConcept code
          Specific event that occurred or that was averted, such as patient fall, wrong organ removed, or wrong blood transfused.
        • contributingFactor
          List<AdverseEvent.AdverseEventContributingFactorComponent> contributingFactor
          The contributing factors suspected to have increased the probability or severity of the adverse event.
        • detected
          DateTimeType detected
          Estimated or actual date the AdverseEvent began, in the opinion of the reporter.
        • encounter
          Reference encounter
          The Encounter associated with the start of the AdverseEvent.
        • identifier
          List<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.
        • mitigatingAction
          List<AdverseEvent.AdverseEventMitigatingActionComponent> mitigatingAction
          The ameliorating action taken after the adverse event occured in order to reduce the extent of harm.
        • occurrence
          DataType occurrence
          The date (and perhaps time) when the adverse event occurred.
        • outcome
          List<CodeableConcept> outcome
          Describes the type of outcome from the adverse event, such as resolved, recovering, ongoing, resolved-with-sequelae, or fatal.
        • participant
          List<AdverseEvent.AdverseEventParticipantComponent> participant
          Indicates who or what participated in the adverse event and how they were involved.
        • preventiveAction
          List<AdverseEvent.AdverseEventPreventiveActionComponent> preventiveAction
          Preventive actions that contributed to avoiding 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.
        • resultingCondition
          List<Reference> resultingCondition
          Information about the condition that occurred as a result of the adverse event, such as hives due to the exposure to a substance (for example, a drug or a chemical) or a broken leg as a result of the fall.
        • seriousness
          CodeableConcept seriousness
          Assessment whether this event, or averted event, was of clinical importance.
        • status
          Enumeration<AdverseEvent.AdverseEventStatus> status
          The current state of the adverse event or potential adverse event.
        • study
          List<Reference> study
          The research study that the subject is enrolled in.
        • subject
          Reference subject
          This subject or group impacted by the event.
        • supportingInfo
          List<AdverseEvent.AdverseEventSupportingInfoComponent> supportingInfo
          Supporting information relevant to the event.
        • suspectEntity
          List<AdverseEvent.AdverseEventSuspectEntityComponent> suspectEntity
          Describes the entity that is suspected to have caused the adverse event.
    • Class org.hl7.fhir.r5.model.AdverseEvent.AdverseEventActualityEnumFactory

      class AdverseEventActualityEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.AdverseEvent.AdverseEventContributingFactorComponent

      class AdverseEventContributingFactorComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1847936859L
      • Serialized Fields

        • item
          DataType item
          The item that is suspected to have increased the probability or severity of the adverse event.
    • Class org.hl7.fhir.r5.model.AdverseEvent.AdverseEventMitigatingActionComponent

      class AdverseEventMitigatingActionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1847936859L
      • Serialized Fields

        • item
          DataType item
          The ameliorating action taken after the adverse event occured in order to reduce the extent of harm.
    • Class org.hl7.fhir.r5.model.AdverseEvent.AdverseEventParticipantComponent

      class AdverseEventParticipantComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -576943815L
      • Serialized Fields

        • actor
          Reference actor
          Indicates who or what participated in the event.
        • function
          CodeableConcept function
          Distinguishes the type of involvement of the actor in the adverse event, such as contributor or informant.
    • Class org.hl7.fhir.r5.model.AdverseEvent.AdverseEventPreventiveActionComponent

      class AdverseEventPreventiveActionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1847936859L
      • Serialized Fields

        • item
          DataType item
          The action that contributed to avoiding the adverse event.
    • Class org.hl7.fhir.r5.model.AdverseEvent.AdverseEventStatusEnumFactory

      class AdverseEventStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.AdverseEvent.AdverseEventSupportingInfoComponent

      class AdverseEventSupportingInfoComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1847936859L
      • Serialized Fields

        • item
          DataType item
          Relevant past history for the subject. In a clinical care context, an example being a patient had an adverse event following a pencillin administration and the patient had a previously documented penicillin allergy. In a clinical trials context, an example is a bunion or rash that was present prior to the study. Additionally, the supporting item can be a document that is relevant to this instance of the adverse event that is not part of the subject's medical history. For example, a clinical note, staff list, or material safety data sheet (MSDS). Supporting information is not a contributing factor, preventive action, or mitigating action.
    • Class org.hl7.fhir.r5.model.AdverseEvent.AdverseEventSuspectEntityCausalityComponent

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

        • assessmentMethod
          CodeableConcept assessmentMethod
          The method of evaluating the relatedness of the suspected entity to the event.
        • author
          Reference author
          The author of the information on the possible cause of the event.
        • entityRelatedness
          CodeableConcept entityRelatedness
          The result of the assessment regarding the relatedness of the suspected entity to the event.
    • Class org.hl7.fhir.r5.model.AdverseEvent.AdverseEventSuspectEntityComponent

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

    • Class org.hl7.fhir.r5.model.Age

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

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

        • asserter
          Reference asserter
          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.
        • 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
          DataType 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.
        • 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.
        • 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). The verification status pertains to the allergy or intolerance, itself, not to any specific AllergyIntolerance attribute.
    • Class org.hl7.fhir.r5.model.AllergyIntolerance.AllergyIntoleranceCategoryEnumFactory

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

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

      class AllergyIntoleranceReactionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1007789961L
      • 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<CodeableReference> 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.r5.model.AllergyIntolerance.AllergyIntoleranceSeverityEnumFactory

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

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

      class Annotation extends DataType implements Serializable
      serialVersionUID:
      1108562171L
      • Serialized Fields

        • author
          DataType 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.r5.model.Appointment

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

        • account
          List<Reference> account
          The set of accounts that is expected to be used for billing the activities that result from this Appointment.
        • 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).
        • cancellationReason
          CodeableConcept cancellationReason
          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.
        • 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.
        • note
          List<Annotation> note
          Additional notes/comments about the appointment.
        • participant
          List<Appointment.AppointmentParticipantComponent> participant
          List of participants involved in the appointment.
        • patientInstruction
          List<CodeableReference> patientInstruction
          While Appointment.note 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
          CodeableConcept priority
          The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).
        • reason
          List<CodeableReference> reason
          The reason that this appointment is being scheduled. This is more clinical than administrative. This can be coded, or 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.
        • replaces
          List<Reference> replaces
          Appointment replaced by this Appointment in cases where there is a cancellation, the details of the cancellation can be found in the cancellationReason property (on the referenced resource).
        • 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.
        • 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.
        • subject
          Reference subject
          The patient or group associated with the appointment, if they are to be present (usually) then they should also be included in the participant backbone element.
        • supportingInformation
          List<Reference> supportingInformation
          Additional information to support the appointment provided when making the appointment.
    • Class org.hl7.fhir.r5.model.Appointment.AppointmentParticipantComponent

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

        • actor
          Reference actor
          A Person, Location/HealthcareService or Device that is participating in the appointment.
        • period
          Period period
          Participation period of the actor.
        • required
          BooleanType required
          Whether this participant is required to be present at the meeting. If false, the participant is optional.
        • status
          Enumeration<Enumerations.ParticipationStatus> status
          Participation status of the actor.
        • type
          List<CodeableConcept> type
          Role of participant in the appointment.
    • Class org.hl7.fhir.r5.model.Appointment.AppointmentStatusEnumFactory

      class AppointmentStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.AppointmentResponse

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

        • actor
          Reference actor
          A Person, Location, HealthcareService, or Device that is participating in the appointment.
        • appointment
          Reference appointment
          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<Enumerations.ParticipationStatus> 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.r5.model.ArtifactAssessment

      class ArtifactAssessment extends MetadataResource implements Serializable
      serialVersionUID:
      -2002325424L
      • 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.
        • artifact
          DataType artifact
          A reference to a resource, canonical resource, or non-FHIR resource which the comment or assessment is about.
        • citeAs
          DataType citeAs
          Display of or reference to the bibliographic citation of the comment, classifier, or rating.
        • content
          List<ArtifactAssessment.ArtifactAssessmentContentComponent> content
          A component comment, classifier, or rating of the artifact.
        • copyright
          MarkdownType copyright
          A copyright statement relating to the artifact assessment and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the artifact assessment.
        • date
          DateTimeType date
          The date (and optionally time) when the artifact assessment was published. The date must change when the disposition changes and it must change if the workflow status code changes. In addition, it should change when the substantive content of the artifact assessment changes.
        • disposition
          Enumeration<ArtifactAssessment.ArtifactAssessmentDisposition> disposition
          Indicates the disposition of the responsible party to the comment or change request.
        • identifier
          List<Identifier> identifier
          A formal identifier that is used to identify this artifact assessment 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.
        • workflowStatus
          Enumeration<ArtifactAssessment.ArtifactAssessmentWorkflowStatus> workflowStatus
          Indicates the workflow status of the comment or change request.
    • Class org.hl7.fhir.r5.model.ArtifactAssessment.ArtifactAssessmentContentComponent

      class ArtifactAssessmentContentComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1157330937L
      • Serialized Fields

        • author
          Reference author
          Indicates who or what authored the content.
        • classifier
          List<CodeableConcept> classifier
          Represents a rating, classifier, or assessment of the artifact.
        • component
          List<ArtifactAssessment.ArtifactAssessmentContentComponent> component
          If the informationType is container, the components of the content.
        • freeToShare
          BooleanType freeToShare
          Acceptable to publicly share the comment, classifier or rating.
        • informationType
          Enumeration<ArtifactAssessment.ArtifactAssessmentInformationType> informationType
          The type of information this component of the content represents.
        • path
          List<UriType> path
          A URI that points to what the comment is about, such as a line of text in the CQL, or a specific element in a resource.
        • relatedArtifact
          List<RelatedArtifact> relatedArtifact
          Additional related artifacts that provide supporting documentation, additional evidence, or further information related to the content.
        • summary
          MarkdownType summary
          A brief summary of the content of this component.
        • type
          CodeableConcept type
          Indicates what type of content this component represents.
    • Class org.hl7.fhir.r5.model.ArtifactAssessment.ArtifactAssessmentDispositionEnumFactory

      class ArtifactAssessmentDispositionEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.ArtifactAssessment.ArtifactAssessmentInformationTypeEnumFactory

      class ArtifactAssessmentInformationTypeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.ArtifactAssessment.ArtifactAssessmentWorkflowStatusEnumFactory

      class ArtifactAssessmentWorkflowStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.Attachment

      class Attachment extends DataType implements Serializable
      serialVersionUID:
      -1904332061L
      • 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.
        • duration
          DecimalType duration
          The duration of the recording in seconds - for audio and video.
        • frames
          PositiveIntType frames
          The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.
        • hash
          Base64BinaryType hash
          The calculated hash of the data using SHA-1. Represented using base64.
        • height
          PositiveIntType height
          Height of the image in pixels (photo/video).
        • language
          CodeType language
          The human language of the content. The value can be any valid value according to BCP 47.
        • pages
          PositiveIntType pages
          The number of pages when printed.
        • size
          Integer64Type 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.
        • width
          PositiveIntType width
          Width of the image in pixels (photo/video).
    • Class org.hl7.fhir.r5.model.AuditEvent

      class AuditEvent extends DomainResource implements Serializable
      serialVersionUID:
      1019127386L
      • Serialized Fields

        • action
          Enumeration<AuditEvent.AuditEventAction> action
          Indicator for type of action performed during the event that generated the audit.
        • agent
          List<AuditEvent.AuditEventAgentComponent> agent
          An actor taking an active role in the event or activity that is logged.
        • authorization
          List<CodeableConcept> authorization
          The authorization (e.g., PurposeOfUse) that was used during the event being recorded.
        • basedOn
          List<Reference> basedOn
          Allows tracing of authorizatino for the events and tracking whether proposals/recommendations were acted upon.
        • category
          List<CodeableConcept> category
          Classification of the type of event.
        • code
          CodeableConcept code
          Describes what happened. The most specific code for the event.
        • encounter
          Reference encounter
          This will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests).
        • entity
          List<AuditEvent.AuditEventEntityComponent> entity
          Specific instances of data or objects that have been accessed.
        • occurred
          DataType occurred
          The time or period during which the activity occurred.
        • outcome
          AuditEvent.AuditEventOutcomeComponent outcome
          Indicates whether the event succeeded or failed. A free text descripiton can be given in outcome.text.
        • recorded
          InstantType recorded
          The time when the event was recorded.
        • severity
          Enumeration<AuditEvent.AuditEventSeverity> severity
          Indicates and enables segmentation of various severity including debugging from critical.
        • source
          AuditEvent.AuditEventSourceComponent source
          The actor that is reporting the event.
    • Class org.hl7.fhir.r5.model.AuditEvent.AuditEventActionEnumFactory

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

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

        • authorization
          List<CodeableConcept> authorization
          The authorization (e.g., PurposeOfUse) that was used during the event being recorded.
        • location
          Reference location
          Where the agent location is known, the agent location when the event occurred.
        • network
          DataType network
          When the event utilizes a network there should be an agent describing the local system, and an agent describing remote system, with the network interface details.
        • policy
          List<UriType> policy
          Where the policy(ies) are known that authorized the agent participation in the event. 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.
        • 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 structural roles of the agent indicating the agent's competency. The security role enabling the agent with respect to the activity.
        • type
          CodeableConcept type
          The Functional Role of the user when performing the event.
        • who
          Reference who
          Reference to who this agent is that was involved in the event.
    • Class org.hl7.fhir.r5.model.AuditEvent.AuditEventEntityComponent

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

        • agent
          List<AuditEvent.AuditEventAgentComponent> agent
          The entity is attributed to an agent to express the agent's responsibility for that entity in the activity. This is most used to indicate when persistence media (the entity) are used by an agent. For example when importing data from a device, the device would be described in an entity, and the user importing data from that media would be indicated as the entity.agent.
        • detail
          List<AuditEvent.AuditEventEntityDetailComponent> detail
          Tagged value pairs for conveying additional information about the entity.
        • query
          Base64BinaryType query
          The query parameters for a query-type entities.
        • role
          CodeableConcept role
          Code representing the role the entity played in the event being audited.
        • securityLabel
          List<CodeableConcept> securityLabel
          Security labels for the identified entity.
        • what
          Reference what
          Identifies a specific instance of the entity. The reference should be version specific.
    • Class org.hl7.fhir.r5.model.AuditEvent.AuditEventEntityDetailComponent

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

        • type
          CodeableConcept type
          The type of extra detail provided in the value.
        • value
          DataType value
          The value of the extra detail.
    • Class org.hl7.fhir.r5.model.AuditEvent.AuditEventOutcomeComponent

      class AuditEventOutcomeComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1108329559L
      • Serialized Fields

        • code
          Coding code
          Indicates whether the event succeeded or failed.
        • detail
          List<CodeableConcept> detail
          Additional details about the error. This may be a text description of the error or a system code that identifies the error.
    • Class org.hl7.fhir.r5.model.AuditEvent.AuditEventSeverityEnumFactory

      class AuditEventSeverityEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.AuditEvent.AuditEventSourceComponent

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

        • observer
          Reference observer
          Identifier of the source where the event was detected.
        • site
          Reference 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<CodeableConcept> type
          Code specifying the type of source where event originated.
    • Class org.hl7.fhir.r5.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.r5.model.BackboneType

      class BackboneType extends DataType 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.r5.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.r5.model.Base64BinaryType

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

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

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

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

      class BaseNarrative extends DataType implements Serializable
    • Class org.hl7.fhir.r5.model.BaseReference

      class BaseReference extends DataType implements Serializable
    • Class org.hl7.fhir.r5.model.BaseResource

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

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

        • author
          Reference author
          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.
    • Class org.hl7.fhir.r5.model.Binary

      class Binary extends BaseBinary implements Serializable
      serialVersionUID:
      65831526L
      • 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. 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.r5.model.BiologicallyDerivedProduct

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

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

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

        • collected
          DataType collected
          Time of product collection.
        • collector
          Reference collector
          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.
    • Class org.hl7.fhir.r5.model.BiologicallyDerivedProduct.BiologicallyDerivedProductPropertyComponent

      class BiologicallyDerivedProductPropertyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1659186716L
      • Serialized Fields

    • Class org.hl7.fhir.r5.model.BiologicallyDerivedProduct.BiologicallyDerivedProductStatusEnumFactory

      class BiologicallyDerivedProductStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.BodyStructure

      class BodyStructure extends DomainResource implements Serializable
      serialVersionUID:
      1435296914L
      • 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.
        • excludedStructure
          List<BodyStructure.BodyStructureExcludedStructureComponent> excludedStructure
          The anatomical location(s) or region(s) not occupied or represented by the specimen, lesion, or 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.
        • includedStructure
          List<BodyStructure.BodyStructureIncludedStructureComponent> includedStructure
          The anatomical location(s) or region(s) of the specimen, lesion, or body structure.
        • location
          CodeableConcept location
          The anatomical location or region of the specimen, lesion, or body structure.
        • 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.
    • Class org.hl7.fhir.r5.model.BodyStructure.BodyStructureExcludedStructureComponent

      class BodyStructureExcludedStructureComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -2036673377L
      • Serialized Fields

        • laterality
          CodeableConcept laterality
          Code that represents the excluded structure laterality.
        • qualifier
          List<CodeableConcept> qualifier
          Code that represents the excluded structure qualifier.
        • structure
          CodeableConcept structure
          Code that represents the excluded structure.
    • Class org.hl7.fhir.r5.model.BodyStructure.BodyStructureIncludedStructureComponent

      class BodyStructureIncludedStructureComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -2036673377L
      • Serialized Fields

        • laterality
          CodeableConcept laterality
          Code that represents the included structure laterality.
        • qualifier
          List<CodeableConcept> qualifier
          Code that represents the included structure qualifier.
        • structure
          CodeableConcept structure
          Code that represents the included structure.
    • Class org.hl7.fhir.r5.model.BooleanType

      class BooleanType extends PrimitiveType<Boolean> implements Externalizable
      serialVersionUID:
      3L
    • Class org.hl7.fhir.r5.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.r5.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.r5.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.r5.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.r5.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.r5.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.r5.model.Bundle.BundleTypeEnumFactory

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

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

      class SearchEntryModeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.CanonicalResource

      class CanonicalResource extends DomainResource implements Serializable
      serialVersionUID:
      0L
    • Class org.hl7.fhir.r5.model.CanonicalType

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

      class CapabilityStatement extends CanonicalResource implements Serializable
      serialVersionUID:
      1554492069L
      • Serialized Fields

        • contact
          List<ContactDetail> contact
          Contact details to assist a user in finding and communicating with the publisher.
        • 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.
        • date
          DateTimeType date
          The date (and optionally time) when the capability statement 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 capability statement changes.
        • description
          MarkdownType description
          A free text natural language description of the capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.
        • document
          List<CapabilityStatement.CapabilityStatementDocumentComponent> document
          A document definition.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        • 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.
        • jurisdiction
          List<CodeableConcept> jurisdiction
          A legal or geographic region in which the capability statement is intended to be used.
        • kind
          Enumeration<Enumerations.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.
        • name
          StringType name
          A natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • patchFormat
          List<CodeType> patchFormat
          A list of the patch formats supported by this implementation using their content types.
        • publisher
          StringType publisher
          The name of the organization or individual that published the capability statement.
        • 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.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this capability statement. Enables tracking the life-cycle of the content.
        • title
          StringType title
          A short, descriptive, user-friendly title for the capability statement.
        • url
          UriType url
          An absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this capability statement is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement is stored on different servers.
        • useContext
          List<UsageContext> useContext
          The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate capability statement instances.
        • version
          StringType version
          The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
    • Class org.hl7.fhir.r5.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.r5.model.CapabilityStatement.CapabilityStatementImplementationComponent

      class CapabilityStatementImplementationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1681322786L
      • 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.
        • 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.r5.model.CapabilityStatement.CapabilityStatementMessagingComponent

      class CapabilityStatementMessagingComponent extends BackboneElement implements Serializable
      serialVersionUID:
      300411231L
    • Class org.hl7.fhir.r5.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.r5.model.CapabilityStatement.CapabilityStatementMessagingSupportedMessageComponent

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

      class CapabilityStatementRestComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1442029817L
    • Class org.hl7.fhir.r5.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.r5.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](operationdefinition.html#) 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.r5.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](searchparameter-definitions.html#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.r5.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.r5.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.r5.model.CapabilityStatement.ConditionalDeleteStatusEnumFactory

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

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

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

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

      class ReferenceHandlingPolicyEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.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.r5.model.CapabilityStatement.ResourceVersionPolicyEnumFactory

      class ResourceVersionPolicyEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.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.r5.model.CapabilityStatement.SystemRestfulInteractionEnumFactory

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

      class TypeRestfulInteractionEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.CapabilityStatement2

      class CapabilityStatement2 extends CanonicalResource implements Serializable
      serialVersionUID:
      -242661375L
      • Serialized Fields

        • contact
          List<ContactDetail> contact
          Contact details to assist a user in finding and communicating with the publisher.
        • copyright
          MarkdownType copyright
          A copyright statement relating to the capability statement2 and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement2.
        • date
          DateTimeType date
          The date (and optionally time) when the capability statement2 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 capability statement2 changes.
        • description
          MarkdownType description
          A free text natural language description of the capability statement2 from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this capability statement2 is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        • fhirVersion
          Enumeration<Enumerations.FHIRVersion> fhirVersion
          The version of the FHIR specification that this CapabilityStatement2 describes (which SHALL be the same as the FHIR version of the CapabilityStatement2 itself). There is no default value.
        • format
          List<CodeType> format
          A list of the formats supported by this implementation using their content types.
        • implementation
          CapabilityStatement2.CapabilityStatement2ImplementationComponent 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 CapabilityStatement2 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 CapabilityStatement2 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.
        • jurisdiction
          List<CodeableConcept> jurisdiction
          A legal or geographic region in which the capability statement2 is intended to be used.
        • kind
          Enumeration<Enumerations.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).
        • name
          StringType name
          A natural language name identifying the capability statement2. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • patchFormat
          List<CodeType> patchFormat
          A list of the patch formats supported by this implementation using their content types.
        • publisher
          StringType publisher
          The name of the organization or individual that published the capability statement2.
        • purpose
          MarkdownType purpose
          Explanation of why this capability statement2 is needed and why it has been designed as it has.
        • rest
          List<CapabilityStatement2.CapabilityStatement2RestComponent> rest
          A definition of the restful capabilities of the solution, if any.
        • software
          CapabilityStatement2.CapabilityStatement2SoftwareComponent 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.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this capability statement2. Enables tracking the life-cycle of the content.
        • title
          StringType title
          A short, descriptive, user-friendly title for the capability statement2.
        • url
          UriType url
          An absolute URI that is used to identify this capability statement2 when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this capability statement2 is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement2 is stored on different servers.
        • useContext
          List<UsageContext> useContext
          The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate capability statement2 instances.
        • version
          StringType version
          The identifier that is used to identify this version of the capability statement2 when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement2 author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
    • Class org.hl7.fhir.r5.model.CapabilityStatement2.CapabilityFeatureEnumFactory

      class CapabilityFeatureEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.CapabilityStatement2.CapabilityFeatureValueEnumFactory

      class CapabilityFeatureValueEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.CapabilityStatement2.CapabilityStatement2ImplementationComponent

      class CapabilityStatement2ImplementationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1681322786L
      • 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.
        • 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.r5.model.CapabilityStatement2.CapabilityStatement2RestComponent

      class CapabilityStatement2RestComponent extends BackboneElement implements Serializable
      serialVersionUID:
      2139914073L
    • Class org.hl7.fhir.r5.model.CapabilityStatement2.CapabilityStatement2RestFeatureComponent

      class CapabilityStatement2RestFeatureComponent extends BackboneElement implements Serializable
      serialVersionUID:
      782619829L
    • Class org.hl7.fhir.r5.model.CapabilityStatement2.CapabilityStatement2RestResourceComponent

      class CapabilityStatement2RestResourceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -815167785L
      • Serialized Fields

        • documentation
          MarkdownType documentation
          Additional information about the resource type used by the system.
        • feature
          List<CapabilityStatement2.CapabilityStatement2RestFeatureComponent> feature
          A statement that affirms support for a feature, in this context.
        • interaction
          List<CapabilityStatement2.ResourceInteractionComponent> interaction
          Identifies a restful operation supported by the solution.
        • operation
          List<CapabilityStatement2.CapabilityStatement2RestResourceOperationComponent> 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).
        • searchParam
          List<CapabilityStatement2.CapabilityStatement2RestResourceSearchParamComponent> 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.
        • 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.
    • Class org.hl7.fhir.r5.model.CapabilityStatement2.CapabilityStatement2RestResourceOperationComponent

      class CapabilityStatement2RestResourceOperationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1206974170L
      • 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](operationdefinition.html#) 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.
        • feature
          List<CapabilityStatement2.CapabilityStatement2RestFeatureComponent> feature
          A statement that affirms support for a feature, in this context.
        • 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.r5.model.CapabilityStatement2.CapabilityStatement2RestResourceSearchParamComponent

      class CapabilityStatement2RestResourceSearchParamComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -300448290L
      • 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](searchparameter-definitions.html#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.
        • feature
          List<CapabilityStatement2.CapabilityStatement2RestFeatureComponent> feature
          A statement that affirms support for a feature, in this context.
        • 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.r5.model.CapabilityStatement2.CapabilityStatement2SoftwareComponent

      class CapabilityStatement2SoftwareComponent 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.r5.model.CapabilityStatement2.ResourceInteractionComponent

      class ResourceInteractionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -543206334L
    • Class org.hl7.fhir.r5.model.CapabilityStatement2.SystemInteractionComponent

      class SystemInteractionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      353704493L
    • Class org.hl7.fhir.r5.model.CapabilityStatement2.SystemRestfulInteractionEnumFactory

      class SystemRestfulInteractionEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.CapabilityStatement2.TypeRestfulInteractionEnumFactory

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

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

        • activity
          List<CarePlan.CarePlanActivityComponent> activity
          Identifies an action that has occurred or is a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring that has occurred, education etc.
        • addresses
          List<CodeableReference> addresses
          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.
        • basedOn
          List<Reference> basedOn
          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.
        • 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.
        • 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.
        • goal
          List<Reference> goal
          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.
        • 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.
        • status
          Enumeration<Enumerations.RequestStatus> 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.
        • 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.
        • title
          StringType title
          Human-friendly name for the care plan.
    • Class org.hl7.fhir.r5.model.CarePlan.CarePlanActivityComponent

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

        • performedActivity
          List<CodeableReference> performedActivity
          Identifies the activity that was performed. For example, an activity could be patient education, exercise, or a medication administration. The reference to an "event" resource, such as Procedure or Encounter or Observation, represents the activity that was performed. The requested activity can be conveyed using CarePlan.activity.plannedActivityDetail OR using the CarePlan.activity.plannedActivityReference (a reference to a ?request? resource).
        • plannedActivityDetail
          CarePlan.CarePlanActivityPlannedActivityDetailComponent plannedActivityDetail
          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.
        • plannedActivityReference
          Reference plannedActivityReference
          The details of the proposed activity represented in a specific resource.
        • progress
          List<Annotation> progress
          Notes about the adherence/status/progress of the activity.
    • Class org.hl7.fhir.r5.model.CarePlan.CarePlanActivityKindEnumFactory

      class CarePlanActivityKindEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.CarePlan.CarePlanActivityPlannedActivityDetailComponent

      class CarePlanActivityPlannedActivityDetailComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1258570436L
      • 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.
        • 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
          CodeableReference location
          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.
        • product
          DataType 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.
        • reason
          List<CodeableReference> reason
          Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited - either a coded concept, or 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.
        • reported
          DataType reported
          Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.
        • scheduled
          DataType 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.r5.model.CarePlan.CarePlanActivityStatusEnumFactory

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

      class CarePlanIntentEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.CareTeam

      class CareTeam extends DomainResource implements Serializable
      serialVersionUID:
      1147350970L
      • 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.
        • 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.
        • 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.
        • reason
          List<CodeableReference> reason
          Describes why the care team exists.
        • 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.
        • telecom
          List<ContactPoint> telecom
          A central contact detail for the care team (that applies to all members).
    • Class org.hl7.fhir.r5.model.CareTeam.CareTeamParticipantComponent

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

        • coverage
          DataType coverage
          When the member is generally available within this care team.
        • member
          Reference member
          The specific person or organization who is participating/expected to participate in the care team.
        • onBehalfOf
          Reference onBehalfOf
          The organization of the practitioner.
        • role
          CodeableConcept role
          Indicates specific responsibility of an individual within the care team, such as "Primary care physician", "Trained social worker counselor", "Caregiver", etc.
    • Class org.hl7.fhir.r5.model.CareTeam.CareTeamStatusEnumFactory

      class CareTeamStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.ChargeItem

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

        • account
          List<Reference> account
          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.
        • costCenter
          Reference costCenter
          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.
        • 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
          DataType 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.
        • performer
          List<ChargeItem.ChargeItemPerformerComponent> performer
          Indicates who or what performed or participated in the charged service.
        • performingOrganization
          Reference performingOrganization
          The organization requesting the service.
        • priceOverride
          Money priceOverride
          Total price of the charge overriding the list price associated with the code.
        • product
          List<CodeableReference> 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.
        • service
          List<Reference> service
          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.
        • supportingInformation
          List<Reference> supportingInformation
          Further information supporting this charge.
    • Class org.hl7.fhir.r5.model.ChargeItem.ChargeItemPerformerComponent

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

        • actor
          Reference actor
          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.r5.model.ChargeItem.ChargeItemStatusEnumFactory

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

      class ChargeItemDefinition extends MetadataResource implements Serializable
      serialVersionUID:
      -789505112L
      • 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.
        • contact
          List<ContactDetail> contact
          Contact details to assist a user in finding and communicating with the publisher.
        • 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.
        • date
          DateTimeType date
          The date (and optionally time) when the charge item definition 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 charge item definition changes.
        • 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.
        • description
          MarkdownType description
          A free text natural language description of the charge item definition from a consumer's perspective.
        • effectivePeriod
          Period effectivePeriod
          The period during which the charge item definition content was or is planned to be in active use.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        • 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).
        • jurisdiction
          List<CodeableConcept> jurisdiction
          A legal or geographic region in which the charge item definition is intended to be used.
        • 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.
        • publisher
          StringType publisher
          The name of the organization or individual that published the charge item definition.
        • 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.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The current state of the ChargeItemDefinition.
        • title
          StringType title
          A short, descriptive, user-friendly title for the charge item definition.
        • url
          UriType url
          An absolute URI that is used to identify this charge item definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this charge item definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the charge item definition is stored on different servers.
        • useContext
          List<UsageContext> useContext
          The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate charge item definition instances.
        • version
          StringType version
          The identifier that is used to identify this version of the charge item definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the charge item definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.
    • Class org.hl7.fhir.r5.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.r5.model.ChargeItemDefinition.ChargeItemDefinitionPropertyGroupComponent

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

      class ChargeItemDefinitionPropertyGroupPriceComponentComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1223988958L
      • Serialized Fields

        • amount
          Money amount
          The amount calculated for this component.
        • code
          CodeableConcept code
          A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.
        • factor
          DecimalType factor
          The factor that has been applied on the base price for calculating this component.
        • type
          Enumeration<Enumerations.InvoicePriceComponentType> type
          This code identifies the type of the component.
    • Class org.hl7.fhir.r5.model.Citation

      class Citation extends MetadataResource implements Serializable
      serialVersionUID:
      3140818L
      • 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
          Who authored the Citation.
        • citedArtifact
          Citation.CitationCitedArtifactComponent citedArtifact
          The article or artifact being described.
        • classification
          List<Citation.CitationClassificationComponent> classification
          The assignment to an organizing scheme.
        • contact
          List<ContactDetail> contact
          Contact details to assist a user in finding and communicating with the publisher.
        • copyright
          MarkdownType copyright
          Use and/or publishing restrictions for the Citation, not for the cited artifact.
        • currentState
          List<CodeableConcept> currentState
          The status of the citation.
        • date
          DateTimeType date
          The date (and optionally time) when the citation 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 citation changes.
        • description
          MarkdownType description
          A free text natural language description of the citation from a consumer's perspective.
        • editor
          List<ContactDetail> editor
          Who edited the Citation.
        • effectivePeriod
          Period effectivePeriod
          The period during which the citation content was or is planned to be in active use.
        • endorser
          List<ContactDetail> endorser
          Who endorsed the Citation.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this citation is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        • identifier
          List<Identifier> identifier
          A formal identifier that is used to identify this citation when it is represented in other formats, or referenced in a specification, model, design or an instance.
        • jurisdiction
          List<CodeableConcept> jurisdiction
          A legal or geographic region in which the citation is intended to be used.
        • 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.
        • name
          StringType name
          A natural language name identifying the citation. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • note
          List<Annotation> note
          Used for general notes and annotations not coded elsewhere.
        • publisher
          StringType publisher
          The name of the organization or individual that published the citation.
        • purpose
          MarkdownType purpose
          Explanation of why this citation is needed and why it has been designed as it has.
        • relatedArtifact
          List<RelatedArtifact> relatedArtifact
          Artifact related to the Citation Resource.
        • reviewer
          List<ContactDetail> reviewer
          Who reviewed the Citation.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this summary. Enables tracking the life-cycle of the content.
        • statusDate
          List<Citation.CitationStatusDateComponent> statusDate
          An effective date or period for a status of the citation.
        • summary
          List<Citation.CitationSummaryComponent> summary
          A human-readable display of the citation.
        • title
          StringType title
          A short, descriptive, user-friendly title for the citation.
        • url
          UriType url
          An absolute URI that is used to identify this citation when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers.
        • useContext
          List<UsageContext> useContext
          The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate citation instances.
        • version
          StringType version
          The identifier that is used to identify this version of the citation when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the citation author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
    • Class org.hl7.fhir.r5.model.Citation.CitationCitedArtifactAbstractComponent

      class CitationCitedArtifactAbstractComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1882363442L
      • Serialized Fields

        • copyright
          MarkdownType copyright
          Copyright notice for the abstract.
        • language
          CodeableConcept language
          Used to express the specific language.
        • text
          MarkdownType text
          Abstract content.
        • type
          CodeableConcept type
          Used to express the reason or specific aspect for the abstract.
    • Class org.hl7.fhir.r5.model.Citation.CitationCitedArtifactClassificationComponent

      class CitationCitedArtifactClassificationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1887617918L
    • Class org.hl7.fhir.r5.model.Citation.CitationCitedArtifactClassificationWhoClassifiedComponent

      class CitationCitedArtifactClassificationWhoClassifiedComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1835300032L
      • Serialized Fields

        • classifierCopyright
          StringType classifierCopyright
          Rights management statement for the classification.
        • freeToShare
          BooleanType freeToShare
          Acceptable to re-use the classification.
        • organization
          Reference organization
          Organization who created the classification.
        • person
          Reference person
          Person who created the classification.
        • publisher
          Reference publisher
          The publisher of the classification, not the publisher of the article or artifact being cited.
    • Class org.hl7.fhir.r5.model.Citation.CitationCitedArtifactComponent

      class CitationCitedArtifactComponent extends BackboneElement implements Serializable
      serialVersionUID:
      356898023L
    • Class org.hl7.fhir.r5.model.Citation.CitationCitedArtifactContributorshipComponent

      class CitationCitedArtifactContributorshipComponent extends BackboneElement implements Serializable
      serialVersionUID:
      78346599L
    • Class org.hl7.fhir.r5.model.Citation.CitationCitedArtifactContributorshipEntryAffiliationInfoComponent

      class CitationCitedArtifactContributorshipEntryAffiliationInfoComponent extends BackboneElement implements Serializable
      serialVersionUID:
      548335522L
      • Serialized Fields

        • affiliation
          StringType affiliation
          Display for the organization.
        • identifier
          List<Identifier> identifier
          Identifier for the organization.
        • role
          StringType role
          Role within the organization, such as professional title.
    • Class org.hl7.fhir.r5.model.Citation.CitationCitedArtifactContributorshipEntryComponent

      class CitationCitedArtifactContributorshipEntryComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1625647137L
    • Class org.hl7.fhir.r5.model.Citation.CitationCitedArtifactContributorshipEntryContributionInstanceComponent

      class CitationCitedArtifactContributorshipEntryContributionInstanceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -196837729L
      • Serialized Fields

    • Class org.hl7.fhir.r5.model.Citation.CitationCitedArtifactContributorshipSummaryComponent

      class CitationCitedArtifactContributorshipSummaryComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1353383781L
      • Serialized Fields

        • source
          CodeableConcept source
          Used to code the producer or rule for creating the display string.
        • style
          CodeableConcept style
          The format for the display string.
        • type
          CodeableConcept type
          Used most commonly to express an author list or a contributorship statement.
        • value
          MarkdownType value
          The display string for the author list, contributor list, or contributorship statement.
    • Class org.hl7.fhir.r5.model.Citation.CitationCitedArtifactPartComponent

      class CitationCitedArtifactPartComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -765350500L
      • Serialized Fields

        • baseCitation
          Reference baseCitation
          The citation for the full article or artifact.
        • type
          CodeableConcept type
          The kind of component.
        • value
          StringType value
          The specification of the component.
    • Class org.hl7.fhir.r5.model.Citation.CitationCitedArtifactPublicationFormComponent

      class CitationCitedArtifactPublicationFormComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -191740896L
      • Serialized Fields

    • Class org.hl7.fhir.r5.model.Citation.CitationCitedArtifactPublicationFormPeriodicReleaseComponent

      class CitationCitedArtifactPublicationFormPeriodicReleaseComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -474554951L
    • Class org.hl7.fhir.r5.model.Citation.CitationCitedArtifactPublicationFormPeriodicReleaseDateOfPublicationComponent

      class CitationCitedArtifactPublicationFormPeriodicReleaseDateOfPublicationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1585589146L
      • Serialized Fields

        • date
          DateType date
          Date on which the issue of the journal was published.
        • day
          StringType day
          Day on which the issue of the journal was published.
        • month
          StringType month
          Month on which the issue of the journal was published.
        • season
          StringType season
          Spring, Summer, Fall/Autumn, Winter.
        • text
          StringType text
          Text representation of the date of which the issue of the journal was published.
        • year
          StringType year
          Year on which the issue of the journal was published.
    • Class org.hl7.fhir.r5.model.Citation.CitationCitedArtifactPublicationFormPublishedInComponent

      class CitationCitedArtifactPublicationFormPublishedInComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1440066953L
      • Serialized Fields

        • identifier
          List<Identifier> identifier
          Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN.
        • publisher
          Reference publisher
          Name of the publisher.
        • publisherLocation
          StringType publisherLocation
          Geographic location of the publisher.
        • title
          StringType title
          Name of the database or title of the book or journal.
        • type
          CodeableConcept type
          Kind of container (e.g. Periodical, database, or book).
    • Class org.hl7.fhir.r5.model.Citation.CitationCitedArtifactStatusDateComponent

      class CitationCitedArtifactStatusDateComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1123586924L
      • Serialized Fields

        • activity
          CodeableConcept activity
          Classification of the status.
        • actual
          BooleanType actual
          Either occurred or expected.
        • period
          Period period
          When the status started and/or ended.
    • Class org.hl7.fhir.r5.model.Citation.CitationCitedArtifactTitleComponent

      class CitationCitedArtifactTitleComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1526221998L
      • Serialized Fields

    • Class org.hl7.fhir.r5.model.Citation.CitationCitedArtifactVersionComponent

      class CitationCitedArtifactVersionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1437090319L
      • Serialized Fields

        • baseCitation
          Reference baseCitation
          Citation for the main version of the cited artifact.
        • value
          StringType value
          The version number or other version identifier.
    • Class org.hl7.fhir.r5.model.Citation.CitationCitedArtifactWebLocationComponent

      class CitationCitedArtifactWebLocationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1300703403L
      • Serialized Fields

        • classifier
          List<CodeableConcept> classifier
          Code the reason for different URLs, e.g. abstract and full-text.
        • url
          UriType url
          The specific URL.
    • Class org.hl7.fhir.r5.model.Citation.CitationClassificationComponent

      class CitationClassificationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -283121869L
      • Serialized Fields

    • Class org.hl7.fhir.r5.model.Citation.CitationStatusDateComponent

      class CitationStatusDateComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1123586924L
      • Serialized Fields

        • activity
          CodeableConcept activity
          Classification of the status.
        • actual
          BooleanType actual
          Either occurred or expected.
        • period
          Period period
          When the status started and/or ended.
    • Class org.hl7.fhir.r5.model.Citation.CitationSummaryComponent

      class CitationSummaryComponent extends BackboneElement implements Serializable
      serialVersionUID:
      123416446L
      • Serialized Fields

    • Class org.hl7.fhir.r5.model.Claim

      class Claim extends DomainResource implements Serializable
      serialVersionUID:
      -1944260506L
      • 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.
        • facility
          Reference facility
          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.
        • 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.
        • 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.
        • 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.
        • 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.
        • referral
          Reference referral
          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<Enumerations.FinancialResourceStatusCodes> 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<Enumerations.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.r5.model.Claim.AccidentComponent

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

        • date
          DateType date
          Date of an accident event related to the products and services contained in the claim.
        • location
          DataType 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.r5.model.Claim.CareTeamComponent

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

        • provider
          Reference provider
          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.r5.model.Claim.DetailComponent

      class DetailComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1330609683L
      • 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.
        • 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.r5.model.Claim.DiagnosisComponent

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

        • diagnosis
          DataType 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.r5.model.Claim.InsuranceComponent

      class InsuranceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      481628099L
      • 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.
        • 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.
        • 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.r5.model.Claim.ItemComponent

      class ItemComponent extends BackboneElement implements Serializable
      serialVersionUID:
      446250357L
      • 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.
        • 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
          DataType 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
          DataType 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.
        • 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.r5.model.Claim.PayeeComponent

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

        • party
          Reference party
          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.r5.model.Claim.ProcedureComponent

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

        • date
          DateTimeType date
          Date and optionally time the procedure was performed.
        • procedure
          DataType 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.
    • Class org.hl7.fhir.r5.model.Claim.RelatedClaimComponent

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

        • claim
          Reference claim
          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.r5.model.Claim.SubDetailComponent

      class SubDetailComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1044001716L
      • 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.
        • 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.r5.model.Claim.SupportingInformationComponent

      class SupportingInformationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      2028146236L
      • 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
          DataType timing
          The date when or period to which this information refers.
        • value
          DataType 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.r5.model.ClaimResponse

      class ClaimResponse extends DomainResource implements Serializable
      serialVersionUID:
      -868588335L
      • 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.
        • 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.
        • 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<Enumerations.ClaimProcessingCodes> 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.
        • 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.
        • status
          Enumeration<Enumerations.FinancialResourceStatusCodes> 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<Enumerations.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.r5.model.ClaimResponse.AddedItemComponent

      class AddedItemComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1008423576L
      • 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
          DataType 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.
        • quantity
          Quantity quantity
          The number of repetitions of a service or product.
        • serviced
          DataType 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.r5.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.r5.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.r5.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.r5.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.r5.model.ClaimResponse.InsuranceComponent

      class InsuranceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -218152446L
      • 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.
        • 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.
        • 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.r5.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.r5.model.ClaimResponse.ItemDetailComponent

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

      class NoteComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -385184277L
    • Class org.hl7.fhir.r5.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.r5.model.ClaimResponse.SubDetailComponent

      class SubDetailComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1083724362L
    • Class org.hl7.fhir.r5.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.r5.model.ClinicalImpression

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

        • 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
          DataType 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.
        • 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.
        • 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.
        • performer
          Reference performer
          The clinician performing the assessment.
        • 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.
        • problem
          List<Reference> problem
          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.
        • 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<Enumerations.EventStatus> 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.
        • summary
          StringType summary
          A text summary of the investigations and the diagnosis.
        • supportingInfo
          List<Reference> supportingInfo
          Information supporting the clinical impression, which can contain investigation results.
    • Class org.hl7.fhir.r5.model.ClinicalImpression.ClinicalImpressionFindingComponent

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

        • basis
          StringType basis
          Which investigations support finding or diagnosis.
        • item
          CodeableReference item
          Specific text, code or reference for finding or diagnosis, which may include ruled-out or resolved conditions.
    • Class org.hl7.fhir.r5.model.ClinicalUseDefinition

      class ClinicalUseDefinition extends DomainResource implements Serializable
      serialVersionUID:
      258286207L
    • Class org.hl7.fhir.r5.model.ClinicalUseDefinition.ClinicalUseDefinitionContraindicationComponent

      class ClinicalUseDefinitionContraindicationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      832395863L
    • Class org.hl7.fhir.r5.model.ClinicalUseDefinition.ClinicalUseDefinitionContraindicationOtherTherapyComponent

      class ClinicalUseDefinitionContraindicationOtherTherapyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -363440718L
      • Serialized Fields

        • relationshipType
          CodeableConcept relationshipType
          The type of relationship between the medicinal product indication or contraindication and another therapy.
        • therapy
          CodeableReference therapy
          Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.
    • Class org.hl7.fhir.r5.model.ClinicalUseDefinition.ClinicalUseDefinitionIndicationComponent

      class ClinicalUseDefinitionIndicationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1882904823L
      • Serialized Fields

    • Class org.hl7.fhir.r5.model.ClinicalUseDefinition.ClinicalUseDefinitionInteractionComponent

      class ClinicalUseDefinitionInteractionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      2072955553L
    • Class org.hl7.fhir.r5.model.ClinicalUseDefinition.ClinicalUseDefinitionInteractionInteractantComponent

      class ClinicalUseDefinitionInteractionInteractantComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1847936859L
      • Serialized Fields

        • item
          DataType item
          The specific medication, food or laboratory test that interacts.
    • Class org.hl7.fhir.r5.model.ClinicalUseDefinition.ClinicalUseDefinitionUndesirableEffectComponent

      class ClinicalUseDefinitionUndesirableEffectComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -55472609L
      • Serialized Fields

        • classification
          CodeableConcept classification
          High level classification of the effect.
        • frequencyOfOccurrence
          CodeableConcept frequencyOfOccurrence
          How often the effect is seen.
        • symptomConditionEffect
          CodeableReference symptomConditionEffect
          The situation in which the undesirable effect may manifest.
    • Class org.hl7.fhir.r5.model.ClinicalUseDefinition.ClinicalUseDefinitionWarningComponent

      class ClinicalUseDefinitionWarningComponent extends BackboneElement implements Serializable
      serialVersionUID:
      213710553L
      • Serialized Fields

        • code
          CodeableConcept code
          A coded or unformatted textual definition of this warning.
        • description
          MarkdownType description
          A textual definition of this warning, with formatting.
    • Class org.hl7.fhir.r5.model.ClinicalUseIssue

      class ClinicalUseIssue extends DomainResource implements Serializable
      serialVersionUID:
      313334576L
    • Class org.hl7.fhir.r5.model.ClinicalUseIssue.ClinicalUseIssueContraindicationComponent

      class ClinicalUseIssueContraindicationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1347024193L
    • Class org.hl7.fhir.r5.model.ClinicalUseIssue.ClinicalUseIssueContraindicationOtherTherapyComponent

      class ClinicalUseIssueContraindicationOtherTherapyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -363440718L
      • Serialized Fields

        • relationshipType
          CodeableConcept relationshipType
          The type of relationship between the medicinal product indication or contraindication and another therapy.
        • therapy
          CodeableReference therapy
          Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.
    • Class org.hl7.fhir.r5.model.ClinicalUseIssue.ClinicalUseIssueIndicationComponent

      class ClinicalUseIssueIndicationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1637864097L
      • Serialized Fields

        • comorbidity
          List<CodeableReference> comorbidity
          A comorbidity (concurrent condition) or coinfection as part of the indication.
        • diseaseStatus
          CodeableReference diseaseStatus
          The status of the disease or symptom for the indication.
        • diseaseSymptomProcedure
          CodeableReference diseaseSymptomProcedure
          The situation that is being documented as an indicaton for this item.
        • duration
          Quantity duration
          Timing or duration information.
        • intendedEffect
          CodeableReference intendedEffect
          The intended effect, aim or strategy to be achieved.
        • otherTherapy
          List<ClinicalUseIssue.ClinicalUseIssueContraindicationOtherTherapyComponent> otherTherapy
          Information about the use of the medicinal product in relation to other therapies described as part of the indication.
        • undesirableEffect
          List<Reference> undesirableEffect
          The specific undesirable effects of the medicinal product.
    • Class org.hl7.fhir.r5.model.ClinicalUseIssue.ClinicalUseIssueInteractionComponent

      class ClinicalUseIssueInteractionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1233301463L
    • Class org.hl7.fhir.r5.model.ClinicalUseIssue.ClinicalUseIssueInteractionInteractantComponent

      class ClinicalUseIssueInteractionInteractantComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1847936859L
      • Serialized Fields

        • item
          DataType item
          The specific medication, food or laboratory test that interacts.
    • Class org.hl7.fhir.r5.model.ClinicalUseIssue.ClinicalUseIssueUndesirableEffectComponent

      class ClinicalUseIssueUndesirableEffectComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -55472609L
      • Serialized Fields

        • classification
          CodeableConcept classification
          High level classification of the effect.
        • frequencyOfOccurrence
          CodeableConcept frequencyOfOccurrence
          How often the effect is seen.
        • symptomConditionEffect
          CodeableReference symptomConditionEffect
          The situation in which the undesirable effect may manifest.
    • Class org.hl7.fhir.r5.model.CodeableConcept

      class CodeableConcept extends DataType 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.r5.model.CodeableReference

      class CodeableReference extends DataType implements Serializable
      serialVersionUID:
      2070287445L
      • Serialized Fields

        • concept
          CodeableConcept concept
          A reference to a concept - e.g. the information is identified by it's general classto the degree of precision found in the terminology.
        • reference
          Reference reference
          A reference to a resource the provides exact details about the information being referenced.
    • Class org.hl7.fhir.r5.model.CodeSystem

      class CodeSystem extends CanonicalResource implements Serializable
      serialVersionUID:
      -499428696L
      • 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.
        • contact
          List<ContactDetail> contact
          Contact details to assist a user in finding and communicating with the publisher.
        • 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.
        • date
          DateTimeType date
          The date (and optionally time) when the code system 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 code system changes.
        • description
          MarkdownType description
          A free text natural language description of the code system from a consumer's perspective.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        • 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.
        • jurisdiction
          List<CodeableConcept> jurisdiction
          A legal or geographic region in which the code system is intended to be used.
        • name
          StringType name
          A natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • property
          List<CodeSystem.PropertyComponent> property
          A property defines an additional slot through which additional information can be provided about a concept.
        • publisher
          StringType publisher
          The name of the organization or individual that published the code system.
        • purpose
          MarkdownType purpose
          Explanation of why this code system is needed and why it has been designed as it has.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The date (and optionally time) when the code system resource was created or revised.
        • supplements
          CanonicalType supplements
          The canonical URL of the code system that this code system supplement is adding designations and properties to.
        • title
          StringType title
          A short, descriptive, user-friendly title for the code system.
        • url
          UriType url
          An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in [Coding](datatypes.html#Coding).system.
        • useContext
          List<UsageContext> useContext
          The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate code system instances.
        • valueSet
          CanonicalType valueSet
          Canonical reference to the value set that contains the entire code system.
        • version
          StringType version
          The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in [Coding](datatypes.html#Coding).version.
        • 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.r5.model.CodeSystem.CodeSystemContentModeEnumFactory

      class CodeSystemContentModeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.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](valueset.html#).compose.include.filter.
        • description
          StringType description
          A description of how or why the filter is used.
        • operator
          List<Enumeration<Enumerations.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.r5.model.CodeSystem.CodeSystemHierarchyMeaningEnumFactory

      class CodeSystemHierarchyMeaningEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.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.r5.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.r5.model.CodeSystem.ConceptPropertyComponent

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

        • code
          CodeType code
          A code that is a reference to CodeSystem.property.code.
        • value
          DataType value
          The value of this property.
    • Class org.hl7.fhir.r5.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.r5.model.CodeSystem.PropertyTypeEnumFactory

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

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

      class Coding extends DataType 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.r5.model.Communication

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

        • about
          List<Reference> about
          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.
        • 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.
        • 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.
        • 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
          A larger event (e.g. Communication, Procedure) of which this particular communication is a component or step.
        • payload
          List<Communication.CommunicationPayloadComponent> payload
          Text, attachment(s), or resource(s) that was communicated to the recipient.
        • priority
          Enumeration<Enumerations.RequestPriority> priority
          Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.
        • reason
          List<CodeableReference> reason
          The reason or justification for the communication.
        • received
          DateTimeType received
          The time when this communication arrived at the destination.
        • recipient
          List<Reference> recipient
          The entity (e.g. person, organization, clinical information system, care team or device) which is the target of the communication.
        • sender
          Reference sender
          The entity (e.g. person, organization, clinical information system, or device) which is the source of the communication.
        • sent
          DateTimeType sent
          The time when this communication was sent.
        • status
          Enumeration<Enumerations.EventStatus> 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.
        • topic
          CodeableConcept topic
          Description of the purpose/content, similar to a subject line in an email.
    • Class org.hl7.fhir.r5.model.Communication.CommunicationPayloadComponent

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

        • content
          DataType content
          A communicated content (or for multi-part communications, one portion of the communication).
    • Class org.hl7.fhir.r5.model.CommunicationRequest

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

        • about
          List<Reference> about
          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.
        • 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.
        • 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.
        • informationProvider
          List<Reference> informationProvider
          The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
        • intent
          Enumeration<Enumerations.RequestIntent> intent
          Indicates the level of authority/intentionality associated with the CommunicationRequest and where the request fits into the workflow chain.
        • 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
          DataType 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<Enumerations.RequestPriority> priority
          Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
        • reason
          List<CodeableReference> reason
          Describes why the request is being made in coded or textual form.
        • 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.
        • replaces
          List<Reference> replaces
          Completed or terminated request(s) whose function is taken by this new request.
        • requester
          Reference requester
          The device, individual, or organization who asks for the information to be shared.
        • status
          Enumeration<Enumerations.RequestStatus> 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.
    • Class org.hl7.fhir.r5.model.CommunicationRequest.CommunicationRequestPayloadComponent

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

        • content
          DataType content
          The communicated content (or for multi-part communications, one portion of the communication).
    • Class org.hl7.fhir.r5.model.CompartmentDefinition

      class CompartmentDefinition extends CanonicalResource implements Serializable
      serialVersionUID:
      1358693010L
      • Serialized Fields

        • code
          Enumeration<Enumerations.CompartmentType> code
          Which compartment this definition describes.
        • contact
          List<ContactDetail> contact
          Contact details to assist a user in finding and communicating with the publisher.
        • date
          DateTimeType date
          The date (and optionally time) when the compartment definition 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 compartment definition changes.
        • description
          MarkdownType description
          A free text natural language description of the compartment definition from a consumer's perspective.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        • name
          StringType name
          A natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • publisher
          StringType publisher
          The name of the organization or individual that published the compartment definition.
        • purpose
          MarkdownType purpose
          Explanation of why this compartment definition is needed and why it has been designed as it has.
        • resource
          List<CompartmentDefinition.CompartmentDefinitionResourceComponent> resource
          Information about how a resource is related to the compartment.
        • search
          BooleanType search
          Whether the search syntax is supported,.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this compartment definition. Enables tracking the life-cycle of the content.
        • url
          UriType url
          An absolute URI that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this compartment definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the compartment definition is stored on different servers.
        • useContext
          List<UsageContext> useContext
          The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate compartment definition instances.
        • version
          StringType version
          The identifier that is used to identify this version of the compartment definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the compartment definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
    • Class org.hl7.fhir.r5.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.r5.model.Composition

      class Composition extends DomainResource implements Serializable
      serialVersionUID:
      446555863L
      • 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.
        • 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
          CodeType confidentiality
          The code specifying the level of confidentiality of the Composition.
        • custodian
          Reference custodian
          Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
        • 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.
        • 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<RelatedArtifact> 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<Enumerations.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).
        • 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.r5.model.Composition.CompositionAttesterComponent

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

        • mode
          CodeableConcept mode
          The type of attestation the authenticator offers.
        • party
          Reference party
          Who attested the composition in the specified way.
        • time
          DateTimeType time
          When the composition was attested by the party.
    • Class org.hl7.fhir.r5.model.Composition.CompositionEventComponent

      class CompositionEventComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1593079240L
      • 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.
        • 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.r5.model.Composition.SectionComponent

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

        • author
          List<Reference> author
          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.
        • 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).
        • mode
          Enumeration<Enumerations.ListMode> 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.r5.model.ConceptMap

      class ConceptMap extends CanonicalResource implements Serializable
      serialVersionUID:
      342671242L
      • Serialized Fields

        • contact
          List<ContactDetail> contact
          Contact details to assist a user in finding and communicating with the publisher.
        • 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.
        • date
          DateTimeType date
          The date (and optionally time) when the concept map 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 concept map changes.
        • description
          MarkdownType description
          A free text natural language description of the concept map from a consumer's perspective.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this concept map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        • group
          List<ConceptMap.ConceptMapGroupComponent> group
          A group of mappings that all have the same source and target system.
        • identifier
          List<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.
        • jurisdiction
          List<CodeableConcept> jurisdiction
          A legal or geographic region in which the concept map is intended to be used.
        • name
          StringType name
          A natural language name identifying the concept map. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • publisher
          StringType publisher
          The name of the organization or individual that published the concept map.
        • purpose
          MarkdownType purpose
          Explanation of why this concept map is needed and why it has been designed as it has.
        • source
          DataType source
          Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this concept map. Enables tracking the life-cycle of the content.
        • target
          DataType 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.
        • title
          StringType title
          A short, descriptive, user-friendly title for the concept map.
        • url
          UriType url
          An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this concept map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the concept map is stored on different servers.
        • useContext
          List<UsageContext> useContext
          The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate concept map instances.
        • version
          StringType version
          The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the concept map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
    • Class org.hl7.fhir.r5.model.ConceptMap.ConceptMapGroupComponent

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

        • element
          List<ConceptMap.SourceElementComponent> element
          Mappings for an individual concept in the source to one or more concepts in the target.
        • source
          CanonicalType source
          An absolute URI that identifies the source system where the concepts to be mapped are defined.
        • target
          CanonicalType target
          An absolute URI that identifies the target system that the concepts will be mapped to.
        • unmapped
          ConceptMap.ConceptMapGroupUnmappedComponent unmapped
          What to do when there is no mapping to a target concept from the source concept. This provides the "default" to be applied when there is no target concept mapping specified. The 'unmapped' element is ignored if a code is specified to have relationship = not-related-to.
    • Class org.hl7.fhir.r5.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<Enumerations.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.r5.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.r5.model.ConceptMap.SourceElementComponent

      class SourceElementComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1876940521L
      • 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.
        • noMap
          BooleanType noMap
          If noMap = true this indicates that no mapping to a target concept exists for this source concept.
        • target
          List<ConceptMap.TargetElementComponent> target
          A concept from the target value set that this concept maps to.
    • Class org.hl7.fhir.r5.model.ConceptMap.TargetElementComponent

      class TargetElementComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1425743857L
      • 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.
        • 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 relationship (e.g., equivalent) cannot be relied on.
        • relationship
          Enumeration<Enumerations.ConceptMapRelationship> relationship
          The relationship between the source and target concepts. The relationship is read from source to target (e.g. source-is-narrower-than-target).
    • Class org.hl7.fhir.r5.model.ConceptMap2

      class ConceptMap2 extends CanonicalResource implements Serializable
      serialVersionUID:
      -601128902L
      • Serialized Fields

        • contact
          List<ContactDetail> contact
          Contact details to assist a user in finding and communicating with the publisher.
        • 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.
        • date
          DateTimeType date
          The date (and optionally time) when the concept map 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 concept map changes.
        • description
          MarkdownType description
          A free text natural language description of the concept map from a consumer's perspective.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this concept map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        • group
          List<ConceptMap2.ConceptMap2GroupComponent> group
          A group of mappings that all have the same source and target system.
        • identifier
          List<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.
        • jurisdiction
          List<CodeableConcept> jurisdiction
          A legal or geographic region in which the concept map is intended to be used.
        • name
          StringType name
          A natural language name identifying the concept map. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • publisher
          StringType publisher
          The name of the organization or individual that published the concept map.
        • purpose
          MarkdownType purpose
          Explanation of why this concept map is needed and why it has been designed as it has.
        • source
          DataType source
          Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this concept map. Enables tracking the life-cycle of the content.
        • target
          DataType 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.
        • title
          StringType title
          A short, descriptive, user-friendly title for the concept map.
        • url
          UriType url
          An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this concept map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the concept map is stored on different servers.
        • useContext
          List<UsageContext> useContext
          The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate concept map instances.
        • version
          StringType version
          The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the concept map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
    • Class org.hl7.fhir.r5.model.ConceptMap2.ConceptMap2GroupComponent

      class ConceptMap2GroupComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -421651506L
      • Serialized Fields

        • element
          List<ConceptMap2.SourceElementComponent> element
          Mappings for an individual concept in the source to one or more concepts in the target.
        • source
          CanonicalType source
          An absolute URI that identifies the source system where the concepts to be mapped are defined.
        • target
          CanonicalType target
          An absolute URI that identifies the target system that the concepts will be mapped to.
        • unmapped
          ConceptMap2.ConceptMap2GroupUnmappedComponent unmapped
          What to do when there is no mapping to a target concept from the source concept. This provides the "default" to be applied when there is no target concept mapping specified. The 'unmapped' element is ignored if a code is specified to have relationship = not-related-to.
    • Class org.hl7.fhir.r5.model.ConceptMap2.ConceptMap2GroupUnmappedComponent

      class ConceptMap2GroupUnmappedComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1886028069L
      • 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<Enumerations.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 ConceptMap2 resource instance to use for mapping if this ConceptMap2 resource contains no matching mapping for the source concept.
        • valueSet
          CanonicalType valueSet
          The set of fixed codes to use when the mode = 'fixed' - all unmapped codes are mapped to a each of the fixed codes.
    • Class org.hl7.fhir.r5.model.ConceptMap2.OtherElementComponent

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

        • 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.
        • value
          DataType value
          Property value that the map depends on.
    • Class org.hl7.fhir.r5.model.ConceptMap2.SourceElementComponent

      class SourceElementComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1485743554L
      • 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.
        • noMap
          BooleanType noMap
          If noMap = true this indicates that no mapping to a target concept exists for this source concept.
        • target
          List<ConceptMap2.TargetElementComponent> target
          A concept from the target value set that this concept maps to.
        • valueSet
          CanonicalType valueSet
          The set of codes being mapped.
    • Class org.hl7.fhir.r5.model.ConceptMap2.TargetElementComponent

      class TargetElementComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1705844456L
      • 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<ConceptMap2.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.
        • product
          List<ConceptMap2.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 relationship (e.g., equivalent) cannot be relied on.
        • relationship
          Enumeration<Enumerations.ConceptMapRelationship> relationship
          The relationship between the source and target concepts. The relationship is read from source to target (e.g. source-is-narrower-than-target).
        • valueSet
          CanonicalType valueSet
          The set of codes being that the map refers to.
    • Class org.hl7.fhir.r5.model.Condition

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

        • abatement
          DataType 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" - Some conditions, such as chronic conditions, are never really resolved, but they can abate.
        • asserter
          Reference asserter
          Individual or device that 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.
        • 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
          DataType 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.
        • severity
          CodeableConcept severity
          A subjective assessment of the severity of the condition as evaluated by the clinician.
        • stage
          List<Condition.ConditionStageComponent> stage
          A simple summary of the stage such as "Stage 3" or "Early Onset". The determination of the stage is disease-specific, such as cancer, retinopathy of prematurity, kidney diseases, Alzheimer's, or Parkinson disease.
        • subject
          Reference subject
          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. The verification status pertains to the condition, itself, not to any specific condition attribute.
    • Class org.hl7.fhir.r5.model.Condition.ConditionEvidenceComponent

      class ConditionEvidenceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -672691342L
      • 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.
    • Class org.hl7.fhir.r5.model.Condition.ConditionStageComponent

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

        • assessment
          List<Reference> assessment
          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" or "Early Onset". The determination of the stage is disease-specific, such as cancer, retinopathy of prematurity, kidney diseases, Alzheimer's, or Parkinson disease.
        • type
          CodeableConcept type
          The kind of staging, such as pathological or clinical staging.
    • Class org.hl7.fhir.r5.model.ConditionDefinition

      class ConditionDefinition extends MetadataResource implements Serializable
      serialVersionUID:
      1798806914L
      • Serialized Fields

        • bodySite
          CodeableConcept bodySite
          The anatomical location where this condition manifests itself.
        • code
          CodeableConcept code
          Identification of the condition, problem or diagnosis.
        • contact
          List<ContactDetail> contact
          Contact details to assist a user in finding and communicating with the publisher.
        • date
          DateTimeType date
          The date (and optionally time) when the condition definition 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 condition definition changes.
        • definition
          List<UriType> definition
          Formal definitions of the condition. These may be references to ontologies, published clinical protocols or research papers.
        • description
          MarkdownType description
          A free text natural language description of the condition definition from a consumer's perspective.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this condition definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        • hasBodySite
          BooleanType hasBodySite
          Whether bodySite is appropriate to collect for this condition.
        • hasSeverity
          BooleanType hasSeverity
          Whether Severity is appropriate to collect for this condition.
        • hasStage
          BooleanType hasStage
          Whether stage is appropriate to collect for this condition.
        • identifier
          List<Identifier> identifier
          A formal identifier that is used to identify this condition definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
        • jurisdiction
          List<CodeableConcept> jurisdiction
          A legal or geographic region in which the condition definition is intended to be used.
        • medication
          List<ConditionDefinition.ConditionDefinitionMedicationComponent> medication
          Medications particularly relevant for this condition.
        • name
          StringType name
          A natural language name identifying the condition definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • observation
          List<ConditionDefinition.ConditionDefinitionObservationComponent> observation
          Observations particularly relevant to this condition.
        • plan
          List<ConditionDefinition.ConditionDefinitionPlanComponent> plan
          Plan that is appropriate.
        • precondition
          List<ConditionDefinition.ConditionDefinitionPreconditionComponent> precondition
          An observation that suggests that this condition applies.
        • publisher
          StringType publisher
          The name of the organization or individual that published the condition definition.
        • questionnaire
          List<ConditionDefinition.ConditionDefinitionQuestionnaireComponent> questionnaire
          Questionnaire for this condition.
        • severity
          CodeableConcept severity
          A subjective assessment of the severity of the condition as evaluated by the clinician.
        • stage
          CodeableConcept stage
          Clinical stage or grade of a condition. May include formal severity assessments.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this condition definition. Enables tracking the life-cycle of the content.
        • subtitle
          StringType subtitle
          An explanatory or alternate title for the event definition giving additional information about its content.
        • team
          List<Reference> team
          Appropriate team for this condition.
        • title
          StringType title
          A short, descriptive, user-friendly title for the condition definition.
        • url
          UriType url
          An absolute URI that is used to identify this condition definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this condition definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the condition definition is stored on different servers.
        • useContext
          List<UsageContext> useContext
          The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate condition definition instances.
        • version
          StringType version
          The identifier that is used to identify this version of the condition definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the condition definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
    • Class org.hl7.fhir.r5.model.ConditionDefinition.ConditionDefinitionMedicationComponent

      class ConditionDefinitionMedicationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1433986479L
    • Class org.hl7.fhir.r5.model.ConditionDefinition.ConditionDefinitionObservationComponent

      class ConditionDefinitionObservationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1433986479L
    • Class org.hl7.fhir.r5.model.ConditionDefinition.ConditionDefinitionPlanComponent

      class ConditionDefinitionPlanComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1992921787L
    • Class org.hl7.fhir.r5.model.ConditionDefinition.ConditionDefinitionPreconditionComponent

      class ConditionDefinitionPreconditionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1210333235L
    • Class org.hl7.fhir.r5.model.ConditionDefinition.ConditionDefinitionQuestionnaireComponent

      class ConditionDefinitionQuestionnaireComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1791379681L
    • Class org.hl7.fhir.r5.model.ConditionDefinition.ConditionPreconditionTypeEnumFactory

      class ConditionPreconditionTypeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.ConditionDefinition.ConditionQuestionnairePurposeEnumFactory

      class ConditionQuestionnairePurposeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.Consent

      class Consent extends DomainResource implements Serializable
      serialVersionUID:
      1432735278L
      • 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.
        • controller
          List<Reference> controller
          The actor that controls/enforces the access according to the consent.
        • dateTime
          DateTimeType dateTime
          Date and time the consent instance was agreed to.
        • grantee
          List<Reference> grantee
          The entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.
        • grantor
          List<Reference> grantor
          The entity responsible for granting the rights listed in a Consent Directive.
        • identifier
          List<Identifier> identifier
          Unique identifier for this copy of the Consent Statement.
        • manager
          List<Reference> manager
          The actor that manages the consent through its lifecycle.
        • 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.
        • sourceAttachment
          List<Attachment> sourceAttachment
          The source on which this consent statement is based. The source might be a scanned original paper form.
        • sourceReference
          List<Reference> sourceReference
          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 resource.
        • subject
          Reference subject
          The patient/healthcare practitioner or group of persons to whom this consent applies.
        • 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.r5.model.Consent.ConsentDataMeaningEnumFactory

      class ConsentDataMeaningEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.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.r5.model.Consent.ConsentProvisionTypeEnumFactory

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

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

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

        • verificationDate
          List<DateTimeType> verificationDate
          Date(s) verification was collected.
        • verificationType
          CodeableConcept verificationType
          Extensible list of verification type starting with verification and re-validation.
        • verified
          BooleanType verified
          Has the instruction been verified.
        • verifiedBy
          Reference verifiedBy
          The person who conducted the verification/validation of the Grantee decision.
        • verifiedWith
          Reference verifiedWith
          Who verified the instruction (Patient, Relative or other Authorized Person).
    • Class org.hl7.fhir.r5.model.Consent.ProvisionActorComponent

      class ProvisionActorComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1992921787L
      • 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').
        • role
          CodeableConcept role
          How the individual is involved in the resources content that is described in the exception.
    • Class org.hl7.fhir.r5.model.Consent.ProvisionComponent

      class ProvisionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      649023539L
      • 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.
        • expression
          Expression expression
          A computable (FHIRPath or other) definition of what is controlled by this consent.
        • 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.r5.model.Consent.ProvisionDataComponent

      class ProvisionDataComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1735979153L
      • 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.
    • Class org.hl7.fhir.r5.model.ContactDetail

      class ContactDetail extends DataType 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.r5.model.ContactPoint

      class ContactPoint extends DataType 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.r5.model.ContactPoint.ContactPointSystemEnumFactory

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

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

      class Contract extends DomainResource implements Serializable
      serialVersionUID:
      -792431459L
      • 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.
        • 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.
        • 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.
        • 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
          DataType 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.
        • 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.
        • status
          Enumeration<Contract.ContractResourceStatusCodes> status
          The status of the resource instance.
        • subject
          List<Reference> subject
          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.
        • 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
          DataType 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.r5.model.Contract.ActionComponent

      class ActionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      337159017L
      • 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.
        • 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
          DataType 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.
        • performerType
          List<CodeableConcept> performerType
          The type of individual that is desired or required to perform or not perform the action.
        • reason
          List<CodeableReference> reason
          Rationale for the action to be performed or not performed. Describes why the action is permitted or prohibited. Either a coded concept, or another resource whose existence justifies permitting or not permitting this action.
        • 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.
        • 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.
        • 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.r5.model.Contract.ActionSubjectComponent

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

        • reference
          List<Reference> 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.r5.model.Contract.AnswerComponent

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

        • value
          DataType 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.r5.model.Contract.AssetContextComponent

      class AssetContextComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -388598648L
      • 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.
        • text
          StringType text
          Context description.
    • Class org.hl7.fhir.r5.model.Contract.ComputableLanguageComponent

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

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

      class ContentDefinitionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      306178803L
      • 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.ContractResourcePublicationStatusCodes> publicationStatus
          amended | appended | cancelled | disputed | entered-in-error | executable +.
        • publisher
          Reference publisher
          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.r5.model.Contract.ContractAssetComponent

      class ContractAssetComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -581986730L
      • 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.
        • usePeriod
          List<Period> usePeriod
          Time period of asset use.
        • valuedItem
          List<Contract.ValuedItemComponent> valuedItem
          Contract Valued Item List.
    • Class org.hl7.fhir.r5.model.Contract.ContractOfferComponent

      class ContractOfferComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -852140711L
      • 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).
        • 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.r5.model.Contract.ContractPartyComponent

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

    • Class org.hl7.fhir.r5.model.Contract.ContractResourcePublicationStatusCodesEnumFactory

      class ContractResourcePublicationStatusCodesEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.Contract.ContractResourceStatusCodesEnumFactory

      class ContractResourceStatusCodesEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.Contract.FriendlyLanguageComponent

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

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

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

        • content
          DataType content
          Contract legal text in human renderable form.
    • Class org.hl7.fhir.r5.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.r5.model.Contract.SignatoryComponent

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

        • party
          Reference party
          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.r5.model.Contract.TermComponent

      class TermComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1647037544L
      • 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
          DataType 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.r5.model.Contract.ValuedItemComponent

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

        • effectiveTime
          DateTimeType effectiveTime
          Indicates the time during which this Contract ValuedItem information is effective.
        • entity
          DataType 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.
        • responsible
          Reference responsible
          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.r5.model.Contributor

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

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

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

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

        • beneficiary
          Reference beneficiary
          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.
        • 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 designator 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.
        • 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.
        • relationship
          CodeableConcept relationship
          The relationship of beneficiary (patient) to the subscriber.
        • status
          Enumeration<Enumerations.FinancialResourceStatusCodes> 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
          Identifier subscriberId
          The insurer assigned ID for the Subscriber.
        • 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.r5.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, type may be used to identify a class of coverage or employer group, policy, or plan.
        • value
          StringType value
          The alphanumeric string value associated with the insurer issued label.
    • Class org.hl7.fhir.r5.model.Coverage.CostToBeneficiaryComponent

      class CostToBeneficiaryComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1531646137L
      • 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
          DataType value
          The amount due from the patient for the cost category.
    • Class org.hl7.fhir.r5.model.Coverage.ExemptionComponent

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

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

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

        • created
          DateTimeType created
          The date when this resource was created.
        • enterer
          Reference enterer
          Person who created the request.
        • facility
          Reference facility
          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.
        • 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.
        • priority
          CodeableConcept priority
          When the requestor expects the processor to complete processing.
        • provider
          Reference provider
          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
          DataType serviced
          The date or dates when the enclosed suite of services were performed or completed.
        • status
          Enumeration<Enumerations.FinancialResourceStatusCodes> 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.r5.model.CoverageEligibilityRequest.DetailsComponent

      class DetailsComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1615052611L
      • 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.
        • diagnosis
          List<CoverageEligibilityRequest.DiagnosisComponent> diagnosis
          Patient diagnosis for which care is sought.
        • facility
          Reference facility
          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.
        • 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.r5.model.CoverageEligibilityRequest.DiagnosisComponent

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

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

      class EligibilityRequestPurposeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.CoverageEligibilityRequest.InsuranceComponent

      class InsuranceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1656150261L
      • 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.
        • 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.r5.model.CoverageEligibilityRequest.SupportingInformationComponent

      class SupportingInformationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1430960090L
      • 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.
        • sequence
          PositiveIntType sequence
          A number to uniquely identify supporting information entries.
    • Class org.hl7.fhir.r5.model.CoverageEligibilityResponse

      class CoverageEligibilityResponse extends DomainResource implements Serializable
      serialVersionUID:
      235292922L
      • 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.
        • outcome
          Enumeration<CoverageEligibilityResponse.EligibilityOutcome> 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.
        • 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.
        • serviced
          DataType serviced
          The date or dates when the enclosed suite of services were performed or completed.
        • status
          Enumeration<Enumerations.FinancialResourceStatusCodes> status
          The status of the resource instance.
    • Class org.hl7.fhir.r5.model.CoverageEligibilityResponse.BenefitComponent

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

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

      class EligibilityOutcomeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.CoverageEligibilityResponse.EligibilityResponsePurposeEnumFactory

      class EligibilityResponsePurposeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.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.r5.model.CoverageEligibilityResponse.InsuranceComponent

      class InsuranceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1473928476L
      • 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.
        • 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.r5.model.CoverageEligibilityResponse.ItemsComponent

      class ItemsComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1706159945L
      • 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.
        • 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.r5.model.DataRequirement

      class DataRequirement extends DataType implements Serializable
      serialVersionUID:
      -1379674933L
      • 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
          DataType subject
          The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
        • type
          Enumeration<Enumerations.FHIRAllTypes> 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.r5.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.r5.model.DataRequirement.DataRequirementDateFilterComponent

      class DataRequirementDateFilterComponent extends Element implements Serializable
      serialVersionUID:
      1649787979L
      • 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
          DataType 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.r5.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.r5.model.DataRequirement.SortDirectionEnumFactory

      class SortDirectionEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.DataType

      class DataType extends Element implements Serializable
      serialVersionUID:
      0L
    • Class org.hl7.fhir.r5.model.DateTimeType

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

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

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

      class DetectedIssue extends DomainResource implements Serializable
      serialVersionUID:
      -781032584L
      • 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.
        • 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
          DataType 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.
        • 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.
        • 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<Enumerations.ObservationStatus> status
          Indicates the status of the detected issue.
    • Class org.hl7.fhir.r5.model.DetectedIssue.DetectedIssueEvidenceComponent

      class DetectedIssueEvidenceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -672691342L
      • 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.
    • Class org.hl7.fhir.r5.model.DetectedIssue.DetectedIssueMitigationComponent

      class DetectedIssueMitigationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1797436956L
      • 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.
        • date
          DateTimeType date
          Indicates when the mitigating action was documented.
    • Class org.hl7.fhir.r5.model.DetectedIssue.DetectedIssueSeverityEnumFactory

      class DetectedIssueSeverityEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.Device

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

        • associationStatus
          Device.DeviceAssociationStatusComponent associationStatus
          The state of the usage or application of the device - whether the device is implanted, or explanted, or attached to the patient.
        • biologicalSource
          Identifier biologicalSource
          An identifier that supports traceability to the biological entity that is the source of biological material in the product.
        • contact
          List<ContactPoint> contact
          Contact details for an organization or a particular human that is responsible for the device.
        • definition
          CodeableReference definition
          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.
        • displayName
          StringType displayName
          The name used to display by default when the device is referenced. Based on intent of use by the resource creator, this may reflect one of the names in Device.deviceName, or may be another simple name.
        • endpoint
          List<Reference> endpoint
          Technical endpoints providing access to services provided by the device defined at this resource.
        • 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.
        • link
          List<Device.DeviceLinkComponent> link
          An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device.
        • location
          Reference location
          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 or entity legally responsible for the device.
        • modelNumber
          StringType modelNumber
          The manufacturer's model number for the device.
        • note
          List<Annotation> note
          Descriptive information, usage information or implantation information that is not captured in an existing element.
        • operationalStatus
          Device.DeviceOperationalStatusComponent operationalStatus
          The status of the device itself - whether it is switched on, or activated, etc.
        • owner
          Reference owner
          An organization that is responsible for the provision and ongoing maintenance of the device.
        • parent
          Reference parent
          The device that this device is attached to or is part of.
        • partNumber
          StringType partNumber
          The part number or catalog number of the device.
        • 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.
        • status
          Enumeration<Device.FHIRDeviceStatus> status
          Status of the Device record. This is not the status of the device like availability.
        • statusReason
          List<CodeableConcept> statusReason
          Reason for the status of the Device record. For example, why is the record not active.
        • subject
          Reference subject
          Patient information, if the device is affixed to, or associated to a patient for their specific use, irrespective of the procedure, use, observation, or other activity that the device is involved in.
        • type
          List<CodeableConcept> type
          The kind or type of device. A device instance may have more than one type - in which case those are the types that apply to the specific instance of the 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.r5.model.Device.DeviceAssociationStatusComponent

      class DeviceAssociationStatusComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1425627429L
      • Serialized Fields

        • reason
          List<CodeableConcept> reason
          The reasons given for the current association status - i.e. why is the device explanted, or attached to the patient, etc.
        • value
          CodeableConcept value
          implanted|explanted|attached.
    • Class org.hl7.fhir.r5.model.Device.DeviceDeviceNameComponent

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

        • name
          StringType name
          The name that identifies the device.
        • type
          Enumeration<Enumerations.DeviceNameType> type
          The type of deviceName. Note that ManufactureDeviceName means that the name is the name as given by the manufacturer, not the name of the manufacturer. RegisteredName | UserFriendlyName | PatientReportedName.
    • Class org.hl7.fhir.r5.model.Device.DeviceLinkComponent

      class DeviceLinkComponent extends BackboneElement implements Serializable
      serialVersionUID:
      627614461L
      • Serialized Fields

        • relatedDevice
          CodeableReference relatedDevice
          A reference to the linked device.
        • relation
          Coding relation
          The type indicates the relationship of the related device to the device instance.
    • Class org.hl7.fhir.r5.model.Device.DeviceOperationalStatusComponent

      class DeviceOperationalStatusComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1425627429L
      • Serialized Fields

        • reason
          List<CodeableConcept> reason
          The reasons given for the current operational status - i.e. why is the device switched on etc.
        • value
          CodeableConcept value
          on |off | standby.
    • Class org.hl7.fhir.r5.model.Device.DevicePropertyComponent

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

        • type
          CodeableConcept type
          Code that specifies the property being represented. No codes are specified but the MDC codes are an example: https://build.fhir.org/mdc.html.
        • value
          DataType value
          Property value - can be a code, quantity, boolean, string or attachment.
    • Class org.hl7.fhir.r5.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-diI, 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 # Informationsstelle für Arzneispezialitäten (IFA GmbH) (EU only): http://hl7.org/fhir/NamingSystem/ifa-gmbh-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/us-fda-udi or in the European Union by the European Commission http://hl7.org/fhir/NamingSystem/eu-ec-udi.
    • Class org.hl7.fhir.r5.model.Device.DeviceVersionComponent

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

        • component
          Identifier component
          The hardware or software module of the device to which the version applies.
        • type
          CodeableConcept type
          The type of the device version, e.g. manufacturer, approved, internal.
        • value
          StringType value
          The version text.
    • Class org.hl7.fhir.r5.model.Device.FHIRDeviceStatusEnumFactory

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

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

      class DeviceDefinition extends DomainResource implements Serializable
      serialVersionUID:
      1434026898L
    • Class org.hl7.fhir.r5.model.DeviceDefinition.DeviceCorrectiveActionScopeEnumFactory

      class DeviceCorrectiveActionScopeEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.DeviceDefinition.DeviceDefinitionChargeItemComponent

      class DeviceDefinitionChargeItemComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1312166907L
      • Serialized Fields

        • chargeItemCode
          CodeableReference chargeItemCode
          The code or reference for the charge item.
        • count
          Quantity count
          Coefficient applicable to the billing code.
        • effectivePeriod
          Period effectivePeriod
          A specific time period in which this charge item applies.
        • useContext
          List<UsageContext> useContext
          The context to which this charge item applies.
    • Class org.hl7.fhir.r5.model.DeviceDefinition.DeviceDefinitionClassificationComponent

      class DeviceDefinitionClassificationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1343788026L
      • Serialized Fields

        • justification
          List<RelatedArtifact> justification
          Further information qualifying this classification of the device model.
        • type
          CodeableConcept type
          A classification or risk class of the device model.
    • Class org.hl7.fhir.r5.model.DeviceDefinition.DeviceDefinitionCorrectiveActionComponent

      class DeviceDefinitionCorrectiveActionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1936691252L
      • Serialized Fields

        • period
          Period period
          Start and end dates of the corrective action.
        • recall
          BooleanType recall
          Whether the last corrective action known for this device was a recall.
        • scope
          Enumeration<DeviceDefinition.DeviceCorrectiveActionScope> scope
          The scope of the corrective action - whether the action targeted all units of a given device model, or only a specific set of batches identified by lot numbers, or individually identified devices identified by the serial name.
    • Class org.hl7.fhir.r5.model.DeviceDefinition.DeviceDefinitionDeviceNameComponent

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

        • name
          StringType name
          A human-friendly name that is used to refer to the device - depending on the type, it can be the brand name, the common name or alias, or other.
        • type
          Enumeration<Enumerations.DeviceNameType> type
          The type of deviceName. RegisteredName | UserFriendlyName | PatientReportedName.
    • Class org.hl7.fhir.r5.model.DeviceDefinition.DeviceDefinitionGuidelineComponent

      class DeviceDefinitionGuidelineComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -591777054L
      • Serialized Fields

        • contraindication
          List<CodeableReference> contraindication
          A specific situation when a device should not be used because it may cause harm.
        • indication
          List<CodeableReference> indication
          A clinical condition for which the device was designed to be used.
        • intendedUse
          StringType intendedUse
          A description of the general purpose or medical use of the device or its function.
        • relatedArtifact
          List<RelatedArtifact> relatedArtifact
          A source of information or reference for this guideline.
        • usageInstruction
          MarkdownType usageInstruction
          Detailed written and visual directions for the user on how to use the device.
        • useContext
          List<UsageContext> useContext
          The circumstances that form the setting for using the device.
        • warning
          List<CodeableReference> warning
          Specific hazard alert information that a user needs to know before using the device.
    • Class org.hl7.fhir.r5.model.DeviceDefinition.DeviceDefinitionHasPartComponent

      class DeviceDefinitionHasPartComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1166127369L
      • Serialized Fields

        • count
          IntegerType count
          Number of instances of the component device in the current device.
        • reference
          Reference reference
          Reference to the device that is part of the current device.
    • Class org.hl7.fhir.r5.model.DeviceDefinition.DeviceDefinitionLinkComponent

      class DeviceDefinitionLinkComponent extends BackboneElement implements Serializable
      serialVersionUID:
      627614461L
      • Serialized Fields

        • relatedDevice
          CodeableReference relatedDevice
          A reference to the linked device.
        • relation
          Coding relation
          The type indicates the relationship of the related device to the device instance.
    • Class org.hl7.fhir.r5.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
          A substance that the device contains, may contain, or is made of - for example latex - to be used to determine patient compatibility. This is not intended to represent the composition of the device, only the clinically relevant materials.
    • Class org.hl7.fhir.r5.model.DeviceDefinition.DeviceDefinitionPackagingComponent

      class DeviceDefinitionPackagingComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1491079286L
    • Class org.hl7.fhir.r5.model.DeviceDefinition.DeviceDefinitionPackagingDistributorComponent

      class DeviceDefinitionPackagingDistributorComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1587433419L
      • Serialized Fields

        • name
          StringType name
          Distributor's human-readable name.
        • organizationReference
          List<Reference> organizationReference
          Distributor as an Organization resource.
    • Class org.hl7.fhir.r5.model.DeviceDefinition.DeviceDefinitionPackagingUdiDeviceIdentifierComponent

      class DeviceDefinitionPackagingUdiDeviceIdentifierComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1994089622L
    • Class org.hl7.fhir.r5.model.DeviceDefinition.DeviceDefinitionPackagingUdiDeviceIdentifierMarketDistributionComponent

      class DeviceDefinitionPackagingUdiDeviceIdentifierMarketDistributionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1459036847L
      • Serialized Fields

        • marketPeriod
          Period marketPeriod
          Begin and end dates for the commercial distribution of the device.
        • subJurisdiction
          UriType subJurisdiction
          National state or territory to which the marketDistribution refers, typically where the device is commercialized.
    • Class org.hl7.fhir.r5.model.DeviceDefinition.DeviceDefinitionPropertyComponent

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

        • type
          CodeableConcept type
          Code that specifies the property.
        • value
          DataType value
          Property value - the data type depends on the property type.
    • Class org.hl7.fhir.r5.model.DeviceDefinition.DeviceDefinitionUdiDeviceIdentifierComponent

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

        • deviceIdentifier
          StringType deviceIdentifier
          The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdiction provided in the DeviceDefinition.udiDeviceIdentifier.
        • issuer
          UriType issuer
          The organization that assigns the identifier algorithm.
        • jurisdiction
          UriType jurisdiction
          The jurisdiction to which the deviceIdentifier applies.
        • marketDistribution
          List<DeviceDefinition.DeviceDefinitionUdiDeviceIdentifierMarketDistributionComponent> marketDistribution
          The organization that assigns the identifier algorithm.
    • Class org.hl7.fhir.r5.model.DeviceDefinition.DeviceDefinitionUdiDeviceIdentifierMarketDistributionComponent

      class DeviceDefinitionUdiDeviceIdentifierMarketDistributionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1459036847L
      • Serialized Fields

        • marketPeriod
          Period marketPeriod
          Begin and end dates for the commercial distribution of the device.
        • subJurisdiction
          UriType subJurisdiction
          National state or territory to which the marketDistribution recers, typically where the device is commercialized.
    • Class org.hl7.fhir.r5.model.DeviceDefinition.DeviceDefinitionVersionComponent

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

        • component
          Identifier component
          The hardware or software module of the device to which the version applies.
        • type
          CodeableConcept type
          The type of the device version, e.g. manufacturer, approved, internal.
        • value
          StringType value
          The version text.
    • Class org.hl7.fhir.r5.model.DeviceDefinition.DeviceProductionIdentifierInUDIEnumFactory

      class DeviceProductionIdentifierInUDIEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.DeviceDispense

      class DeviceDispense extends DomainResource implements Serializable
      serialVersionUID:
      -1613459109L
      • Serialized Fields

        • basedOn
          List<Reference> basedOn
          The order or request that this dispense is fulfilling.
        • category
          List<CodeableConcept> category
          Indicates the type of device dispense.
        • destination
          Reference destination
          Identification of the facility/location where the device was /should be shipped to, as part of the dispense process.
        • device
          CodeableReference device
          Identifies the device being dispensed. This is either a link to a resource representing the details of the device or a simple attribute carrying a code that identifies the device from a known list of devices.
        • encounter
          Reference encounter
          The encounter that establishes the context for this event.
        • eventHistory
          List<Reference> eventHistory
          A summary of the events of interest that have occurred, such as when the dispense was verified.
        • identifier
          List<Identifier> identifier
          Business identifier for this dispensation.
        • location
          Reference location
          The principal physical location where the dispense was performed.
        • note
          List<Annotation> note
          Extra information about the dispense that could not be conveyed in the other attributes.
        • partOf
          List<Reference> partOf
          The bigger event that this dispense is a part of.
        • performer
          List<DeviceDispense.DeviceDispensePerformerComponent> performer
          Indicates who or what performed the event.
        • preparedDate
          DateTimeType preparedDate
          The time when the dispensed product was packaged and reviewed.
        • quantity
          Quantity quantity
          The number of devices that have been dispensed.
        • status
          Enumeration<DeviceDispense.DeviceDispenseStatusCodes> status
          A code specifying the state of the set of dispense events.
        • statusReason
          CodeableReference statusReason
          Indicates the reason why a dispense was or was not performed.
        • subject
          Reference subject
          A link to a resource representing the person to whom the device is intended.
        • supportingInformation
          List<Reference> supportingInformation
          Additional information that supports the device being dispensed.
        • type
          CodeableConcept type
          Indicates the type of dispensing event that is performed.
        • usageInstruction
          StringType usageInstruction
          The full representation of the instructions.
        • whenHandedOver
          DateTimeType whenHandedOver
          The time the dispensed product was made available to the patient or their representative.
    • Class org.hl7.fhir.r5.model.DeviceDispense.DeviceDispensePerformerComponent

      class DeviceDispensePerformerComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -576943815L
      • Serialized Fields

        • actor
          Reference actor
          The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the device.
        • function
          CodeableConcept function
          Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.
    • Class org.hl7.fhir.r5.model.DeviceDispense.DeviceDispenseStatusCodesEnumFactory

      class DeviceDispenseStatusCodesEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.DeviceMetric

      class DeviceMetric extends DomainResource implements Serializable
      serialVersionUID:
      2132964036L
      • 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.
        • 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.
        • 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.r5.model.DeviceMetric.DeviceMetricCalibrationComponent

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

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

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

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

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

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

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

        • authoredOn
          DateTimeType authoredOn
          When the request transitioned to being actionable.
        • basedOn
          List<Reference> basedOn
          Plan/proposal/order fulfilled by this request.
        • code
          CodeableReference code
          The details of the device to be used.
        • doNotPerform
          BooleanType doNotPerform
          If true, indicates that the provider is asking for the patient to either stop using or to not start using the specified device or category of devices. For example, the patient has undergone surgery and the provider is indicating that the patient should not wear contact lenses.
        • encounter
          Reference encounter
          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.
        • intent
          Enumeration<Enumerations.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
          DataType 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 individual or entity to provide the device to the subject of the request (e.g., patient, location).
        • performerType
          CodeableConcept performerType
          The desired kind of individual or entity to provide the device to the subject of the request (e.g., patient, location).
        • priority
          Enumeration<Enumerations.RequestPriority> priority
          Indicates how quickly the request 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).
        • quantity
          IntegerType quantity
          The number of devices to be provided.
        • reason
          List<CodeableReference> reason
          Reason or justification for the use of this device.
        • relevantHistory
          List<Reference> relevantHistory
          Key events in the history of the request.
        • requester
          Reference requester
          The individual or entity who initiated the request and has responsibility for its activation.
        • status
          Enumeration<Enumerations.RequestStatus> status
          The status of the request.
        • subject
          Reference subject
          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).
    • Class org.hl7.fhir.r5.model.DeviceRequest.DeviceRequestParameterComponent

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

        • code
          CodeableConcept code
          A code or string that identifies the device detail being asserted.
        • value
          DataType value
          The value of the device detail.
    • Class org.hl7.fhir.r5.model.DeviceUsage

      class DeviceUsage extends DomainResource implements Serializable
      serialVersionUID:
      979004394L
      • Serialized Fields

        • basedOn
          List<Reference> basedOn
          A plan, proposal or order that is fulfilled in whole or in part by this DeviceUsage.
        • bodySite
          CodeableReference bodySite
          Indicates the anotomic location on the subject's body where the device was used ( i.e. the target).
        • category
          List<CodeableConcept> category
          This attribute indicates a category for the statement - The device statement may be made in an inpatient or outpatient settting (inpatient | outpatient | community | patientspecified).
        • context
          Reference context
          The encounter or episode of care that establishes the context for this device use statement.
        • dateAsserted
          DateTimeType dateAsserted
          The time at which the statement was recorded by informationSource.
        • derivedFrom
          List<Reference> derivedFrom
          Allows linking the DeviceUsage to the underlying Request, or to other information that supports or is used to derive the DeviceUsage.
        • device
          CodeableReference device
          Code or Reference to device used.
        • identifier
          List<Identifier> identifier
          An external identifier for this statement such as an IRI.
        • informationSource
          Reference informationSource
          Who reported the device was being used by the patient.
        • 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.
        • patient
          Reference patient
          The patient who used the device.
        • reason
          List<CodeableReference> reason
          Reason or justification for the use of the device. A coded concept, or another resource whose existence justifies this DeviceUsage.
        • status
          Enumeration<DeviceUsage.DeviceUsageStatus> 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.
        • timing
          DataType timing
          How often the device was used.
        • usageReason
          List<CodeableConcept> usageReason
          The reason for asserting the usage status - for example forgot, lost, stolen, broken.
        • usageStatus
          CodeableConcept usageStatus
          The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement.
    • Class org.hl7.fhir.r5.model.DeviceUsage.DeviceUsageStatusEnumFactory

      class DeviceUsageStatusEnumFactory extends Object implements Serializable
    • Class org.hl7.fhir.r5.model.DiagnosticReport

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

        • basedOn
          List<Reference> basedOn
          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