Serialized Form

  • Package org.hl7.fhir.r5.elementmodel

  • Package org.hl7.fhir.r5.fhirpath

  • Package org.hl7.fhir.r5.model

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

      class Account extends DomainResource implements Serializable
      serialVersionUID:
      -924752626L

      • Serialized Fields

        • balance
          List<Account.AccountBalanceComponent> balance
          The calculated account balances - these are calculated and processed by the finance system. The balances with a `term` that is not current are usually generated/updated by an invoicing or similar process.
        • 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.
        • calculatedAt
          InstantType calculatedAt
          Time the balance amount was calculated.
        • 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.
        • currency
          CodeableConcept currency
          The default currency for the account.
        • description
          MarkdownType description
          Provides additional information about what the account tracks and how it is used.
        • diagnosis
          List<Account.AccountDiagnosisComponent> diagnosis
          When using an account for billing a specific Encounter the set of diagnoses that are relevant for billing are stored here on the account where they are able to be sequenced appropriately prior to processing to produce claim(s).
        • 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.
        • procedure
          List<Account.AccountProcedureComponent> procedure
          When using an account for billing a specific Encounter the set of procedures that are relevant for billing are stored here on the account where they are able to be sequenced appropriately prior to processing to produce claim(s).
        • relatedAccount
          List<Account.AccountRelatedAccountComponent> relatedAccount
          Other associated accounts related to this 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.AccountBalanceComponent

      class AccountBalanceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -338990145L

      • Serialized Fields

        • aggregate
          CodeableConcept aggregate
          Who is expected to pay this part of the balance.
        • amount
          Money amount
          The actual balance value calculated for the age defined in the term property.
        • estimate
          BooleanType estimate
          The amount is only an estimated value - this is likely common for `current` term balances, but not with known terms (that were generated by a backend process).
        • term
          CodeableConcept term
          The term of the account balances - The balance value is the amount that was outstanding for this age.

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

      class AccountDiagnosisComponent extends BackboneElement implements Serializable
      serialVersionUID:
      57125500L

      • Serialized Fields

        • condition
          CodeableReference condition
          The diagnosis relevant to the account.
        • dateOfDiagnosis
          DateTimeType dateOfDiagnosis
          Ranking of the diagnosis (for each type).
        • onAdmission
          BooleanType onAdmission
          Was the Diagnosis present on Admission in the related Encounter.
        • packageCode
          List<CodeableConcept> packageCode
          The package code can be used to group diagnoses that may be priced or delivered as a single product. Such as DRGs.
        • sequence
          PositiveIntType sequence
          Ranking of the diagnosis (for each type).
        • type
          List<CodeableConcept> type
          Type that this diagnosis has relevant to the account (e.g. admission, billing, discharge ?).

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

      class AccountProcedureComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -797201673L

      • Serialized Fields

        • code
          CodeableReference code
          The procedure relevant to the account.
        • dateOfService
          DateTimeType dateOfService
          Date of the procedure when using a coded procedure. If using a reference to a procedure, then the date on the procedure should be used.
        • device
          List<Reference> device
          Any devices that were associated with the procedure relevant to the account.
        • packageCode
          List<CodeableConcept> packageCode
          The package code can be used to group procedures that may be priced or delivered as a single product. Such as DRGs.
        • sequence
          PositiveIntType sequence
          Ranking of the procedure (for each type).
        • type
          List<CodeableConcept> type
          How this procedure value should be used in charging the account.

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

      class AccountRelatedAccountComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1586291361L

      • Serialized Fields

        • account
          Reference account
          Reference to an associated Account.
        • relationship
          CodeableConcept relationship
          Relationship of the associated Account.

    • 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:
      -1134510373L

      • 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.
        • asNeeded
          DataType asNeeded
          If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.
        • 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.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the activity definition was last significantly changed. 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 asserted by the publisher to be 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.RequestResourceTypes> kind
          A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.
        • 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<CanonicalType> observationRequirement
          Defines observation requirements for the action to be performed, such as body weight or surface area.
        • observationResultRequirement
          List<CanonicalType> 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 responsible for the release and ongoing maintenance of 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 asserted by the publisher to be primarily responsible for review of some aspect of the content.
        • specimenRequirement
          List<CanonicalType> 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 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
          MarkdownType 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • 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 resolvable 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:
      468446682L

      • Serialized Fields

    • Class org.hl7.fhir.r5.model.ActivityDefinition.RequestResourceTypesEnumFactory

      class RequestResourceTypesEnumFactory extends Object implements Serializable

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

      class ActorDefinition extends CanonicalResource implements Serializable
      serialVersionUID:
      -493373068L

      • Serialized Fields

        • capabilities
          CanonicalType capabilities
          The capability statement for the actor (if the concept is applicable).
        • 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 actor definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the actor definition.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the actor definition was last significantly changed. 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 actor definition changes.
        • derivedFrom
          List<CanonicalType> derivedFrom
          A url that identifies the definition of this actor in another IG (which IG must be listed in the dependencies). This actor inherits all the obligations etc. as defined in the other IG.
        • description
          MarkdownType description
          A free text natural language description of the actor.
        • documentation
          MarkdownType documentation
          Documentation about the functionality of the actor.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this actor 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 actor 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 actor definition is intended to be used.
        • name
          StringType name
          A natural language name identifying the actor 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 responsible for the release and ongoing maintenance of the actor definition.
        • purpose
          MarkdownType purpose
          Explanation of why this actor definition is needed and why it has been designed as it has.
        • reference
          List<UrlType> reference
          A reference to additional documentation about the actor, but description and documentation.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this actor definition. Enables tracking the life-cycle of the content.
        • title
          StringType title
          A short, descriptive, user-friendly title for the actor definition.
        • type
          Enumeration<Enumerations.ExampleScenarioActorType> type
          Whether the actor represents a human or an appliction.
        • url
          UriType url
          An absolute URI that is used to identify this actor 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 an authoritative instance of this actor definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the actor 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 actor definition instances.
        • version
          StringType version
          The identifier that is used to identify this version of the actor definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the actor 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • 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:
      -487805677L

      • 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').
        • description
          MarkdownType description
          A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed. Intended to be used when the other structured properties of this resource are insufficient or cannot be supported. It is not intended to duplicate information already carried elswehere.
        • 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
          References a product from which one or more of the constituent parts of that product can be prepared and used as described by this administrable product. If this administrable product describes the administration of a crushed tablet, the 'formOf' would be the product representing a distribution containing tablets and possibly also a cream. This is distinct from the 'producedFrom' which refers to the specific components of the product that are used in this preparation, rather than the product as a whole.
        • 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
          Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form. In some cases, an administrable form might use all of the items from the overall product (or there might only be one item), while in other cases, an administrable form might use only a subset of the items available in the overall product. For example, an administrable form might involve combining a liquid and a powder available as part of an overall product, but not involve applying the also supplied cream.
        • property
          List<AdministrableProductDefinition.AdministrableProductDefinitionPropertyComponent> property
          Characteristics e.g. a product's 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. RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa).
        • 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, specified using a numerical value and its unit of measurement.
        • maxTreatmentPeriod
          Duration maxTreatmentPeriod
          The maximum treatment period during which the 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 applies, 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:
      -1861590732L

      • Serialized Fields

        • actuality
          Enumeration<AdverseEvent.AdverseEventActuality> actuality
          Whether the event actually happened or was a near miss. 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.
        • expectedInResearchStudy
          BooleanType expectedInResearchStudy
          Considered likely or probable or anticipated in the research study. Whether the reported event matches any of the outcomes for the patient that are considered by the study as known or likely.
        • 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.
        • note
          List<Annotation> note
          Comments made about the adverse event by the performer, subject or other participants.
        • 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.
        • resultingEffect
          List<Reference> resultingEffect
          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:
      -1955746770L

      • Serialized Fields

        • 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.
        • participant
          List<AllergyIntolerance.AllergyIntoleranceParticipantComponent> participant
          Indicates who or what participated in the activities related to the allergy or intolerance and how they were involved.
        • 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.
        • type
          CodeableConcept 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.AllergyIntoleranceParticipantComponent

      class AllergyIntoleranceParticipantComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -576943815L

      • Serialized Fields

        • actor
          Reference actor
          Indicates who or what participated in the activities related to the allergy or intolerance.
        • function
          CodeableConcept function
          Distinguishes the type of involvement of the actor in the activities related to the allergy or intolerance.

    • 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.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:
      883088259L

      • 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 request this appointment is allocated to assess (e.g. incoming referral or procedure request).
        • cancellationDate
          DateTimeType cancellationDate
          The date/time describing when the appointment was cancelled.
        • 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.
        • class_
          List<CodeableConcept> class_
          Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
        • 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 note 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.
        • occurrenceChanged
          BooleanType occurrenceChanged
          This appointment varies from the recurring pattern.
        • originatingAppointment
          Reference originatingAppointment
          The originating appointment in a recurring set of related appointments.
        • 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).
        • previousAppointment
          Reference previousAppointment
          The previous appointment in a series of related appointments.
        • 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.
        • recurrenceId
          PositiveIntType recurrenceId
          The sequence number that identifies a specific appointment in a recurring pattern.
        • recurrenceTemplate
          List<Appointment.AppointmentRecurrenceTemplateComponent> recurrenceTemplate
          The details of the recurrence pattern or template that is used to generate recurring appointments.
        • 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<CodeableReference> 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.
        • virtualService
          List<VirtualServiceDetail> virtualService
          Connection details of a virtual service (e.g. conference call).

    • Class org.hl7.fhir.r5.model.Appointment.AppointmentParticipantComponent

      class AppointmentParticipantComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1537536134L

      • Serialized Fields

        • actor
          Reference actor
          The individual, device, location, or service 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<Appointment.ParticipationStatus> status
          Participation status of the actor.
        • type
          List<CodeableConcept> type
          Role of participant in the appointment.

    • Class org.hl7.fhir.r5.model.Appointment.AppointmentRecurrenceTemplateComponent

      class AppointmentRecurrenceTemplateComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1582999176L

    • Class org.hl7.fhir.r5.model.Appointment.AppointmentRecurrenceTemplateMonthlyTemplateComponent

      class AppointmentRecurrenceTemplateMonthlyTemplateComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1234046272L

      • Serialized Fields

        • dayOfMonth
          PositiveIntType dayOfMonth
          Indicates that appointments in the series of recurring appointments should occur on a specific day of the month.
        • dayOfWeek
          Coding dayOfWeek
          Indicates which day of the week the recurring appointments should occur each nth week.
        • monthInterval
          PositiveIntType monthInterval
          Indicates that recurring appointments should occur every nth month.
        • nthWeekOfMonth
          Coding nthWeekOfMonth
          Indicates which week within a month the appointments in the series of recurring appointments should occur on.

    • Class org.hl7.fhir.r5.model.Appointment.AppointmentRecurrenceTemplateWeeklyTemplateComponent

      class AppointmentRecurrenceTemplateWeeklyTemplateComponent extends BackboneElement implements Serializable
      serialVersionUID:
      588795188L

      • Serialized Fields

        • friday
          BooleanType friday
          Indicates that recurring appointments should occur on Fridays.
        • monday
          BooleanType monday
          Indicates that recurring appointments should occur on Mondays.
        • saturday
          BooleanType saturday
          Indicates that recurring appointments should occur on Saturdays.
        • sunday
          BooleanType sunday
          Indicates that recurring appointments should occur on Sundays.
        • thursday
          BooleanType thursday
          Indicates that recurring appointments should occur on Thursdays.
        • tuesday
          BooleanType tuesday
          Indicates that recurring appointments should occur on Tuesdays.
        • wednesday
          BooleanType wednesday
          Indicates that recurring appointments should occur on Wednesdays.
        • weekInterval
          PositiveIntType weekInterval
          The interval defines if the recurrence is every nth week. The default is every week, so it is expected that this value will be 2 or more. e.g. For recurring every second week this interval would be 2, or every third week the interval would be 3.

    • Class org.hl7.fhir.r5.model.Appointment.AppointmentRecurrenceTemplateYearlyTemplateComponent

      class AppointmentRecurrenceTemplateYearlyTemplateComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -120794476L

      • Serialized Fields

        • yearInterval
          PositiveIntType yearInterval
          Appointment recurs every nth year.

    • Class org.hl7.fhir.r5.model.Appointment.AppointmentStatusEnumFactory

      class AppointmentStatusEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Appointment.ParticipationStatusEnumFactory

      class ParticipationStatusEnumFactory extends Object implements Serializable

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

      class AppointmentResponse extends DomainResource implements Serializable
      serialVersionUID:
      -780212279L

      • 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
          MarkdownType 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.
        • occurrenceDate
          DateType occurrenceDate
          The original date within a recurring request. This could be used in place of the recurrenceId to be more direct (or where the template is provided through the simple list of dates in `Appointment.occurrenceDate`).
        • participantStatus
          Enumeration<AppointmentResponse.AppointmentResponseStatus> 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.
        • proposedNewTime
          BooleanType proposedNewTime
          Indicates that the response is proposing a different time that was initially requested. The new proposed time will be indicated in the start and end properties.
        • recurrenceId
          PositiveIntType recurrenceId
          The recurrence ID (sequence number) of the specific appointment when responding to a recurring request.
        • recurring
          BooleanType recurring
          Indicates that this AppointmentResponse applies to all occurrences in a recurring request.
        • start
          InstantType start
          Date/Time that the appointment is to take place, or requested new start time.

    • Class org.hl7.fhir.r5.model.AppointmentResponse.AppointmentResponseStatusEnumFactory

      class AppointmentResponseStatusEnumFactory extends Object implements Serializable

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

      class ArtifactAssessment extends DomainResource implements Serializable
      serialVersionUID:
      525457507L

      • 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.
        • title
          StringType title
          A short title for the assessment for use in displaying and selecting.
        • 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:
      -111630435L

      • 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.
        • quantity
          Quantity quantity
          A quantitative rating of the artifact.
        • 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:
      -1335832480L

      • 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.
        • patient
          Reference patient
          The patient element is available to enable deterministic tracking of activities that involve the patient as the subject of the data used in an activity.
        • 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. This is allowed to be a Parameters resource.

    • 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.Availability

      class Availability extends DataType implements Serializable
      serialVersionUID:
      -444820754L

    • Class org.hl7.fhir.r5.model.Availability.AvailabilityAvailableTimeComponent

      class AvailabilityAvailableTimeComponent extends Element implements Serializable
      serialVersionUID:
      -2139510127L

      • Serialized Fields

        • allDay
          BooleanType allDay
          Always available? i.e. 24 hour service.
        • availableEndTime
          TimeType availableEndTime
          Closing time of day (ignored if allDay = true).
        • availableStartTime
          TimeType availableStartTime
          Opening time of day (ignored if allDay = true).
        • daysOfWeek
          List<Enumeration<Enumerations.DaysOfWeek>> daysOfWeek
          mon | tue | wed | thu | fri | sat | sun.

    • Class org.hl7.fhir.r5.model.Availability.AvailabilityNotAvailableTimeComponent

      class AvailabilityNotAvailableTimeComponent extends Element implements Serializable
      serialVersionUID:
      310849929L

      • Serialized Fields

        • description
          StringType description
          Reason presented to the user explaining why time not available.
        • during
          Period during
          Service not available during this period.

    • 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 managable, 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 managable, 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
        • validationMessages
          List<org.hl7.fhir.utilities.validation.ValidationMessage> validationMessages

    • 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:
      -1635508686L

      • 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
          DateTimeType 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:
      452844848L

      • Serialized Fields

        • biologicalSourceEvent
          Identifier biologicalSourceEvent
          An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled.
        • collection
          BiologicallyDerivedProduct.BiologicallyDerivedProductCollectionComponent collection
          How this product was collected.
        • division
          StringType division
          A unique identifier for an aliquot of a product. Used to distinguish individual aliquots of a product carrying the same biologicalSource and productCode identifiers.
        • expirationDate
          DateTimeType expirationDate
          Date, and where relevant time, of expiration.
        • identifier
          List<Identifier> identifier
          Unique instance identifiers assigned to a biologically derived product. Note: This is a business identifier, not a resource identifier.
        • parent
          List<Reference> parent
          Parent product (if any) for this biologically-derived product.
        • processingFacility
          List<Reference> processingFacility
          Processing facilities responsible for the labeling and distribution of this biologically derived product.
        • productCategory
          Coding productCategory
          Broad category of this product.
        • productCode
          CodeableConcept productCode
          A codified value that systematically supports characterization and classification of medical products of human origin inclusive of processing conditions such as additives, volumes and handling conditions.
        • productStatus
          Coding productStatus
          Whether the product is currently available.
        • property
          List<BiologicallyDerivedProduct.BiologicallyDerivedProductPropertyComponent> property
          A property that is specific to this BiologicallyDerviedProduct instance.
        • request
          List<Reference> request
          Request to obtain and/or infuse this biologically derived product.
        • storageTempRequirements
          Range storageTempRequirements
          The temperature requirements for storage of the biologically-derived product.

    • 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

        • type
          CodeableConcept type
          Code that specifies the property. It should reference an established coding system.
        • value
          DataType value
          Property values.

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

      class BiologicallyDerivedProductDispense extends DomainResource implements Serializable
      serialVersionUID:
      -109945994L

      • Serialized Fields

        • basedOn
          List<Reference> basedOn
          The order or request that the dispense is fulfilling. This is a reference to a ServiceRequest resource.
        • destination
          Reference destination
          Link to a resource identifying the physical location that the product was dispatched to.
        • identifier
          List<Identifier> identifier
          Unique instance identifiers assigned to a biologically derived product dispense. Note: This is a business identifier, not a resource identifier.
        • location
          Reference location
          The physical location where the dispense was performed.
        • matchStatus
          CodeableConcept matchStatus
          Indicates the type of matching associated with the dispense.
        • note
          List<Annotation> note
          Additional notes.
        • originRelationshipType
          CodeableConcept originRelationshipType
          Indicates the relationship between the donor of the biologically derived product and the intended recipient.
        • partOf
          List<Reference> partOf
          A larger event of which this particular event is a component.
        • patient
          Reference patient
          A link to a resource representing the patient that the product is dispensed for.
        • performer
          List<BiologicallyDerivedProductDispense.BiologicallyDerivedProductDispensePerformerComponent> performer
          Indicates who or what performed an action.
        • preparedDate
          DateTimeType preparedDate
          When the product was selected/ matched.
        • product
          Reference product
          A link to a resource identifying the biologically derived product that is being dispensed.
        • quantity
          Quantity quantity
          The amount of product in the dispense. Quantity will depend on the product being dispensed. Examples are: volume; cell count; concentration.
        • status
          Enumeration<BiologicallyDerivedProductDispense.BiologicallyDerivedProductDispenseCodes> status
          A code specifying the state of the dispense event.
        • usageInstruction
          StringType usageInstruction
          Specific instructions for use.
        • whenHandedOver
          DateTimeType whenHandedOver
          When the product was dispatched for clinical use.

    • Class org.hl7.fhir.r5.model.BiologicallyDerivedProductDispense.BiologicallyDerivedProductDispenseCodesEnumFactory

      class BiologicallyDerivedProductDispenseCodesEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.BiologicallyDerivedProductDispense.BiologicallyDerivedProductDispensePerformerComponent

      class BiologicallyDerivedProductDispensePerformerComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -576943815L

      • Serialized Fields

        • actor
          Reference actor
          Identifies the person responsible for the action.
        • function
          CodeableConcept function
          Identifies the function of the performer during the dispense.

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

      class BodyStructure extends DomainResource implements Serializable
      serialVersionUID:
      -1014863022L

      • Serialized Fields

        • active
          BooleanType active
          Whether this body site is in active use.
        • description
          MarkdownType description
          A summary, characterization or explanation of the body structure.
        • excludedStructure
          List<BodyStructure.BodyStructureIncludedStructureComponent> 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.
        • 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.BodyStructureIncludedStructureBodyLandmarkOrientationComponent

      class BodyStructureIncludedStructureBodyLandmarkOrientationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -365770277L

    • Class org.hl7.fhir.r5.model.BodyStructure.BodyStructureIncludedStructureBodyLandmarkOrientationDistanceFromLandmarkComponent

      class BodyStructureIncludedStructureBodyLandmarkOrientationDistanceFromLandmarkComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1883586968L

      • Serialized Fields

        • device
          List<CodeableReference> device
          An instrument, tool, analyzer, etc. used in the measurement.
        • value
          List<Quantity> value
          The measured distance (e.g., in cm) from a body landmark.

    • Class org.hl7.fhir.r5.model.BodyStructure.BodyStructureIncludedStructureComponent

      class BodyStructureIncludedStructureComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1341852782L

    • 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:
      -843739668L

      • 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.
        • issues
          Resource issues
          Captures issues and warnings that relate to the construction of the Bundle and the content within it.
        • 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 JWS.
        • 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 (potentially estimated) 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. Except for transactions and batches, each entry in a Bundle must have a fullUrl. 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. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when: invoking a create invoking or responding to an operation where the body is not a single identified resource invoking or returning the results of a search or history operation.
        • 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. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.
        • 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:
      -878418349L

      • Serialized Fields

        • relation
          Enumeration<Bundle.LinkRelationTypes> 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.LinkRelationTypesEnumFactory

      class LinkRelationTypesEnumFactory 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:
      -1432396321L

      • Serialized Fields

        • acceptLanguage
          List<CodeType> acceptLanguage
          A list of the languages supported by this implementation that are usefully supported in the ```Accept-Language``` header.
        • 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.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the capability statement was last significantly changed. 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.
        • identifier
          List<Identifier> identifier
          A formal identifier that is used to identify this CapabilityStatement when it is represented in other formats, or referenced in a specification, model, design or an instance.
        • 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 responsible for the release and ongoing maintenance of 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 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • 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:
      -1848514556L

      • 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
          MarkdownType 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:
      -1565226425L

      • 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.
        • conditionalPatch
          BooleanType conditionalPatch
          A flag that indicates that the server supports conditional patch.
        • 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 system-wide profile that is applied across *all* instances of the resource supported by the system. For example, if declared on Observation, this profile is the "superset" of capabilities for laboratory *and* vitals *and* other domains. 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 representing different use cases the system hosts/produces. A supported profile is a statement about the functionality of the data and services provided by the server (or the client) for supported use cases. For example, a system can define and declare multiple Observation profiles for laboratory observations, vital sign observations, etc. By declaring supported profiles, systems provide a way to determine whether individual resources are conformant. 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 name is prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called. This SHOULD be the same as the OperationDefinition.code of the defining OperationDefinition. However, it can sometimes differ if necessary to disambiguate when a server supports multiple OperationDefinition that happen to share the same code.

    • 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 label used for the search parameter in this particular system's API - i.e. the 'name' portion of the name-value pair that will appear as part of the search URL. This SHOULD be the same as the SearchParameter.code of the defining SearchParameter. However, it can sometimes differ if necessary to disambiguate when a server supports multiple SearchParameters that happen to share the same code.
        • 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.RestfulCapabilityModeEnumFactory

      class RestfulCapabilityModeEnumFactory 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.CarePlan

      class CarePlan extends DomainResource implements Serializable
      serialVersionUID:
      -700769298L

      • 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.
        • basedOn
          List<Reference> basedOn
          A higher-level request resource (i.e. a plan, proposal or order) 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), organization or device 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.
        • custodian
          Reference custodian
          When populated, the custodian is responsible for the care plan. The care plan is attributed to the custodian.
        • 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:
      1416911432L

      • 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 the CarePlan.activity.plannedActivityReference (a reference to a ?request? resource).
        • 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.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:
      -766813613L

      • 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.
        • 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.
        • encounter
          Reference encounter
          This ChargeItem has the details of how the associated Encounter should be billed or otherwise be handled by finance systems.
        • enteredDate
          DateTimeType enteredDate
          Date the charge item was entered.
        • enterer
          Reference enterer
          The device, practitioner, etc. who entered the charge item.
        • 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
          CodeableConcept 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 performing the service.
        • 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 requesting the service.
        • service
          List<CodeableReference> 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.
        • totalPriceComponent
          MonetaryComponent totalPriceComponent
          The total price for the chargable item, accounting for the quantity.
        • unitPriceComponent
          MonetaryComponent unitPriceComponent
          The unit price of the chargable item.

    • 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:
      900671183L

      • 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.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the charge item definition was last significantly changed. 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.
        • 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.
        • name
          StringType name
          A natural language name identifying the ChargeItemDefinition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • 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 responsible for the release and ongoing maintenance of the charge item definition.
        • purpose
          MarkdownType purpose
          Explanation of why this charge item definition is needed and why it has been designed as it has.
        • 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 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • Class org.hl7.fhir.r5.model.ChargeItemDefinition.ChargeItemDefinitionApplicabilityComponent

      class ChargeItemDefinitionApplicabilityComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1706427366L

      • Serialized Fields

        • condition
          Expression condition
          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.
        • effectivePeriod
          Period effectivePeriod
          The period during which the charge item definition content was or is planned to be in active use.
        • relatedArtifact
          RelatedArtifact relatedArtifact
          Reference to / quotation of the external source of the group of properties.

    • Class org.hl7.fhir.r5.model.ChargeItemDefinition.ChargeItemDefinitionPropertyGroupComponent

      class ChargeItemDefinitionPropertyGroupComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1829474901L

      • Serialized Fields

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

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

      class Citation extends MetadataResource implements Serializable
      serialVersionUID:
      717016163L

      • 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 or created the citation record.
        • 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 record, not for the cited artifact.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • currentState
          List<CodeableConcept> currentState
          The status of the citation record.
        • date
          DateTimeType date
          The date (and optionally time) when the citation record was last significantly changed. 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 record changes.
        • description
          MarkdownType description
          A free text natural language description of the citation from a consumer's perspective.
        • editor
          List<ContactDetail> editor
          Who edited or revised the citation record.
        • effectivePeriod
          Period effectivePeriod
          The period during which the citation record content was or is planned to be in active use.
        • endorser
          List<ContactDetail> endorser
          Who endorsed the citation record.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this citation record 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 record 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 record 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 record. 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 record.
        • 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 record.
        • reviewer
          List<ContactDetail> reviewer
          Who reviewed the citation record.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this summary. Enables tracking the life-cycle of the content.
        • statusDate
          List<Citation.CitationStatusDateComponent> statusDate
          The state or status of the citation record paired with an effective date or period for that state.
        • summary
          List<Citation.CitationSummaryComponent> summary
          A human-readable display of key concepts to represent the citation.
        • title
          StringType title
          A short, descriptive, user-friendly title for the citation record.
        • url
          UriType url
          An absolute URI that is used to identify this citation record 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 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 record instances.
        • version
          StringType version
          The identifier that is used to identify this version of the citation record when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the citation record 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • 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 of the abstract.
        • text
          MarkdownType text
          Abstract content.
        • type
          CodeableConcept type
          Used to express the reason for or classification of the abstract.

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

      class CitationCitedArtifactClassificationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      394554928L

      • Serialized Fields

        • artifactAssessment
          List<Reference> artifactAssessment
          Complex or externally created classification.
        • classifier
          List<CodeableConcept> classifier
          The specific classification value.
        • type
          CodeableConcept type
          The kind of classifier (e.g. publication type, keyword).

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

      class CitationCitedArtifactComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1685890486L

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

      class CitationCitedArtifactContributorshipComponent extends BackboneElement implements Serializable
      serialVersionUID:
      662810405L

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

      class CitationCitedArtifactContributorshipEntryComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1654594857L

      • Serialized Fields

        • affiliation
          List<Reference> affiliation
          Organization affiliated with the contributor.
        • contributionInstance
          List<Citation.CitationCitedArtifactContributorshipEntryContributionInstanceComponent> contributionInstance
          Contributions with accounting for time or number.
        • contributionType
          List<CodeableConcept> contributionType
          This element identifies the specific nature of an individual?s contribution with respect to the cited work.
        • contributor
          Reference contributor
          The identity of the individual contributor.
        • correspondingContact
          BooleanType correspondingContact
          Whether the contributor is the corresponding contributor for the role.
        • forenameInitials
          StringType forenameInitials
          For citation styles that use initials.
        • rankingOrder
          PositiveIntType rankingOrder
          Provides a numerical ranking to represent the degree of contributorship relative to other contributors, such as 1 for first author and 2 for second author.
        • role
          CodeableConcept role
          The role of the contributor (e.g. author, editor, reviewer, funder).

    • 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.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:
      1791622597L

      • Serialized Fields

        • accessionNumber
          StringType accessionNumber
          Entry number or identifier for inclusion in a database.
        • articleDate
          DateTimeType articleDate
          The date the article was added to the database, or the date the article was released.
        • citedMedium
          CodeableConcept citedMedium
          Describes the form of the medium cited. Common codes are "Internet" or "Print". The CitedMedium value set has 6 codes. The codes internet, print, and offline-digital-storage are the common codes for a typical publication form, though internet and print are more common for study citations. Three additional codes (each appending one of the primary codes with "-without-issue" are used for situations when a study is published both within an issue (of a periodical release as commonly done for journals) AND is published separately from the issue (as commonly done with early online publication), to represent specific identification of the publication form not associated with the issue.
        • copyright
          MarkdownType copyright
          Copyright notice for the full article or artifact.
        • firstPage
          StringType firstPage
          Used for isolated representation of first page.
        • issue
          StringType issue
          Issue, part or supplement of journal or other collection in which the article is published.
        • language
          List<CodeableConcept> language
          The language or languages in which this form of the article is published.
        • lastPage
          StringType lastPage
          Used for isolated representation of last page.
        • lastRevisionDate
          DateTimeType lastRevisionDate
          The date the article was last revised or updated in the database.
        • pageCount
          StringType pageCount
          Actual or approximate number of pages or screens. Distinct from reporting the page numbers.
        • pageString
          StringType pageString
          Used for full display of pagination.
        • publicationDateSeason
          StringType publicationDateSeason
          Spring, Summer, Fall/Autumn, Winter.
        • publicationDateText
          StringType publicationDateText
          Text representation of the date on which the issue of the cited artifact was published.
        • publishedIn
          Citation.CitationCitedArtifactPublicationFormPublishedInComponent publishedIn
          The collection the cited article or artifact is published in.
        • volume
          StringType volume
          Volume number of journal or other collection in which the article is 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 or resource describing 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.CitationCitedArtifactRelatesToComponent

      class CitationCitedArtifactRelatesToComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1537406923L

      • Serialized Fields

        • citation
          MarkdownType citation
          A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
        • classifier
          List<CodeableConcept> classifier
          Provides additional classifiers of the related artifact.
        • display
          StringType display
          A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
        • document
          Attachment document
          The document being referenced, represented as an attachment. Do not use this element if using the resource element to provide the canonical to the related artifact.
        • label
          StringType label
          A short label that can be used to reference the related artifact from elsewhere in the containing artifact, such as a footnote index.
        • resource
          CanonicalType resource
          The related artifact, such as a library, value set, profile, or other knowledge resource.
        • resourceReference
          Reference resourceReference
          The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.
        • type
          Enumeration<Citation.RelatedArtifactTypeExpanded> type
          The type of relationship to the related artifact.

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

      class CitationCitedArtifactStatusDateComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1123586924L

      • Serialized Fields

        • activity
          CodeableConcept activity
          A definition of the status associated with a date or period.
        • 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

        • language
          CodeableConcept language
          Used to express the specific language of the title.
        • text
          MarkdownType text
          The title of the article or artifact.
        • type
          List<CodeableConcept> type
          Used to express the reason for or classification of the title.

    • 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
          A characterization of the object expected at the web location.
        • 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
          The state or status of the citation record (that will be paired with the period).
        • actual
          BooleanType actual
          Whether the status date is actual (has occurred) or expected (estimated or anticipated).
        • 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

        • style
          CodeableConcept style
          Format for display of the citation summary.
        • text
          MarkdownType text
          The human-readable display of the citation summary.

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

      class ContributorshipSummaryComponent 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, such as author last name with first letter capitalized followed by forename initials.
        • 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.RelatedArtifactTypeExpandedEnumFactory

      class RelatedArtifactTypeExpandedEnumFactory extends Object implements Serializable

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

      class Claim extends DomainResource implements Serializable
      serialVersionUID:
      -64601265L

      • 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.
        • diagnosisRelatedGroup
          CodeableConcept diagnosisRelatedGroup
          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.
        • encounter
          List<Reference> encounter
          Healthcare encounters related to this claim.
        • enterer
          Reference enterer
          Individual who created the claim, predetermination or preauthorization.
        • event
          List<Claim.ClaimEventComponent> event
          Information code for an event with a corresponding date or period.
        • 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.
        • patientPaid
          Money patientPaid
          The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.
        • 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 is the document/authorization given to the claim author for them to provide products and services for which consideration (reimbursement) is sought. Could be a RX for medications, an 'order' for oxygen or wheelchair or physiotherapy treatments.
        • priority
          CodeableConcept priority
          The provider-required urgency of processing the request. Typical values include: stat, normal, 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
          The referral information received by the claim author, it is not to be used when the author generates a referral for a patient. A copy of that referral may be provided as supporting information. Some insurers require proof of referral to pay for services or to pay specialist rates for services.
        • 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.
        • traceNumber
          List<Identifier> traceNumber
          Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.
        • 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: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided.

    • 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.BodySiteComponent

      class BodySiteComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1190632415L

      • Serialized Fields

        • site
          List<CodeableReference> site
          Physical service site on the patient (limb, tooth, etc.).
        • subSite
          List<CodeableConcept> subSite
          A region or surface of the bodySite, e.g. limb region or tooth surface(s).

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

      class CareTeamComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1238813503L

      • Serialized Fields

        • provider
          Reference provider
          Member of the team who provided the product or 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.
        • specialty
          CodeableConcept specialty
          The specialization of the practitioner or provider which is applicable for this service.

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

      class ClaimEventComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -634897375L

      • Serialized Fields

        • type
          CodeableConcept type
          A coded event such as when a service is expected or a card printed.
        • when
          DataType when
          A date or period in the past or future indicating when the event occurred or is expectd to occur.

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

      class DetailComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -733030497L

      • 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 total amount claimed for the group (if a grouper) or the line item.detail. Net = unit price * quantity * factor.
        • patientPaid
          Money patientPaid
          The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.
        • productOrService
          CodeableConcept productOrService
          When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.
        • productOrServiceEnd
          CodeableConcept productOrServiceEnd
          This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.
        • 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.
        • tax
          Money tax
          The total of taxes applicable for this product or service.
        • traceNumber
          List<Identifier> traceNumber
          Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.
        • 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:
      -320261526L

      • 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.
        • 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:
      -1174144448L

      • Serialized Fields

        • bodySite
          List<Claim.BodySiteComponent> bodySite
          Physical location where the service is performed or applies.
        • 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
          Healthcare encounters related to this claim.
        • 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 total amount claimed for the group (if a grouper) or the line item. Net = unit price * quantity * factor.
        • patientPaid
          Money patientPaid
          The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.
        • 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 item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.
        • productOrServiceEnd
          CodeableConcept productOrServiceEnd
          This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.
        • 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.
        • request
          List<Reference> request
          Request or Referral for Goods or Service to be rendered.
        • 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.
        • tax
          Money tax
          The total of taxes applicable for this product or service.
        • traceNumber
          List<Identifier> traceNumber
          Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.
        • 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:
      -2049468862L

      • 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 total amount claimed for line item.detail.subDetail. Net = unit price * quantity * factor.
        • patientPaid
          Money patientPaid
          The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.
        • productOrService
          CodeableConcept productOrService
          When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.
        • productOrServiceEnd
          CodeableConcept productOrServiceEnd
          This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.
        • 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.
        • tax
          Money tax
          The total of taxes applicable for this product or service.
        • traceNumber
          List<Identifier> traceNumber
          Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.
        • 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:
      -1099970187L

      • 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.
        • decision
          CodeableConcept decision
          The result of the claim, predetermination, or preauthorization adjudication.
        • diagnosisRelatedGroup
          CodeableConcept diagnosisRelatedGroup
          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.
        • disposition
          StringType disposition
          A human readable description of the status of the adjudication.
        • encounter
          List<Reference> encounter
          Healthcare encounters related to this claim.
        • error
          List<ClaimResponse.ErrorComponent> error
          Errors encountered during the processing of the adjudication.
        • event
          List<ClaimResponse.ClaimResponseEventComponent> event
          Information code for an event with a corresponding date or period.
        • 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.
        • traceNumber
          List<Identifier> traceNumber
          Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.
        • 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: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided.

    • Class org.hl7.fhir.r5.model.ClaimResponse.AddedItemComponent

      class AddedItemComponent extends BackboneElement implements Serializable
      serialVersionUID:
      520179532L

      • Serialized Fields

        • adjudication
          List<ClaimResponse.AdjudicationComponent> adjudication
          The adjudication results.
        • bodySite
          List<ClaimResponse.BodySiteComponent> bodySite
          Physical location where the service is performed or applies.
        • 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 total amount claimed for the group (if a grouper) or the addItem. Net = unit price * quantity * factor.
        • 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 item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.
        • productOrServiceEnd
          CodeableConcept productOrServiceEnd
          This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.
        • 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.
        • request
          List<Reference> request
          Request or Referral for Goods or Service to be rendered.
        • revenue
          CodeableConcept revenue
          The type of revenue or cost center providing the product and/or service.
        • reviewOutcome
          ClaimResponse.ReviewOutcomeComponent reviewOutcome
          The high-level results of the adjudication if adjudication has been performed.
        • 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.
        • tax
          Money tax
          The total of taxes applicable for this product or service.
        • traceNumber
          List<Identifier> traceNumber
          Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.
        • 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:
      1574685043L

      • 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 total amount claimed for the group (if a grouper) or the addItem.detail. Net = unit price * quantity * factor.
        • 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 item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.
        • productOrServiceEnd
          CodeableConcept productOrServiceEnd
          This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.
        • 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.
        • reviewOutcome
          ClaimResponse.ReviewOutcomeComponent reviewOutcome
          The high-level results of the adjudication if adjudication has been performed.
        • subDetail
          List<ClaimResponse.AddedItemSubDetailComponent> subDetail
          The third-tier service adjudications for payor added services.
        • tax
          Money tax
          The total of taxes applicable for this product or service.
        • traceNumber
          List<Identifier> traceNumber
          Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.
        • 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:
      -1130518441L

      • 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 total amount claimed for the addItem.detail.subDetail. Net = unit price * quantity * factor.
        • 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 item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.
        • productOrServiceEnd
          CodeableConcept productOrServiceEnd
          This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.
        • 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.
        • reviewOutcome
          ClaimResponse.ReviewOutcomeComponent reviewOutcome
          The high-level results of the adjudication if adjudication has been performed.
        • tax
          Money tax
          The total of taxes applicable for this product or service.
        • traceNumber
          List<Identifier> traceNumber
          Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.
        • 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:
      29312734L

      • 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.
        • quantity
          Quantity quantity
          A non-monetary value associated with the category. Mutually exclusive to the amount element above.
        • reason
          CodeableConcept reason
          A code supporting the understanding of the adjudication result and explaining variance from expected amount.

    • Class org.hl7.fhir.r5.model.ClaimResponse.BodySiteComponent

      class BodySiteComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1190632415L

      • Serialized Fields

        • site
          List<CodeableReference> site
          Physical service site on the patient (limb, tooth, etc.).
        • subSite
          List<CodeableConcept> subSite
          A region or surface of the bodySite, e.g. limb region or tooth surface(s).

    • Class org.hl7.fhir.r5.model.ClaimResponse.ClaimResponseEventComponent

      class ClaimResponseEventComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -634897375L

      • Serialized Fields

        • type
          CodeableConcept type
          A coded event such as when a service is expected or a card printed.
        • when
          DataType when
          A date or period in the past or future indicating when the event occurred or is expectd to occur.

    • Class org.hl7.fhir.r5.model.ClaimResponse.ErrorComponent

      class ErrorComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -514754249L

      • 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.
        • expression
          List<StringType> expression
          A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.
        • 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:
      -1834500828L

      • 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.
        • reviewOutcome
          ClaimResponse.ReviewOutcomeComponent reviewOutcome
          The high-level results of the adjudication if adjudication has been performed.
        • traceNumber
          List<Identifier> traceNumber
          Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

    • Class org.hl7.fhir.r5.model.ClaimResponse.ItemDetailComponent

      class ItemDetailComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1263137525L

    • Class org.hl7.fhir.r5.model.ClaimResponse.NoteComponent

      class NoteComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -944255449L

      • Serialized Fields

        • language
          CodeableConcept language
          A code to define the language used in the text of the note.
        • number
          PositiveIntType number
          A number to uniquely identify a note entry.
        • text
          StringType text
          The explanation or description associated with the processing.
        • type
          CodeableConcept type
          The business purpose of the note text.

    • 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.ReviewOutcomeComponent

      class ReviewOutcomeComponent extends BackboneElement implements Serializable
      serialVersionUID:
      2126097594L

      • Serialized Fields

        • decision
          CodeableConcept decision
          The result of the claim, predetermination, or preauthorization adjudication.
        • 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.
        • reason
          List<CodeableConcept> reason
          The reasons for the result of the claim, predetermination, or preauthorization adjudication.

    • Class org.hl7.fhir.r5.model.ClaimResponse.SubDetailComponent

      class SubDetailComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1370798714L

      • Serialized Fields

        • adjudication
          List<ClaimResponse.AdjudicationComponent> adjudication
          The adjudication results.
        • noteNumber
          List<PositiveIntType> noteNumber
          The numbers associated with notes below which apply to the adjudication of this item.
        • reviewOutcome
          ClaimResponse.ReviewOutcomeComponent reviewOutcome
          The high-level results of the adjudication if adjudication has been performed.
        • subDetailSequence
          PositiveIntType subDetailSequence
          A number to uniquely reference the claim sub-detail entry.
        • traceNumber
          List<Identifier> traceNumber
          Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

    • 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:
      -1360437701L

      • Serialized Fields

        • changePattern
          CodeableConcept changePattern
          Change in the status/pattern of a subject's condition since previously assessed, such as worsening, improving, or no change. It is a subjective assessment of the direction of the change.
        • 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:
      -539149948L

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

      class ClinicalUseDefinitionContraindicationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1942194420L

      • Serialized Fields

        • applicability
          Expression applicability
          An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements.
        • comorbidity
          List<CodeableReference> comorbidity
          A comorbidity (concurrent condition) or coinfection.
        • diseaseStatus
          CodeableReference diseaseStatus
          The status of the disease or symptom for the contraindication, for example "chronic" or "metastatic".
        • diseaseSymptomProcedure
          CodeableReference diseaseSymptomProcedure
          The situation that is being documented as contraindicating against this item.
        • indication
          List<Reference> indication
          The indication which this is a contraidication for.
        • otherTherapy
          List<ClinicalUseDefinition.ClinicalUseDefinitionContraindicationOtherTherapyComponent> otherTherapy
          Information about the use of the medicinal product in relation to other therapies described as part of the contraindication.

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

      class ClinicalUseDefinitionContraindicationOtherTherapyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1638121853L

      • Serialized Fields

        • relationshipType
          CodeableConcept relationshipType
          The type of relationship between the medicinal product indication or contraindication and another therapy.
        • treatment
          CodeableReference treatment
          Reference to a specific medication (active substance, medicinal product or class of products, biological, food etc.) as part of an indication or contraindication.

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

      class ClinicalUseDefinitionIndicationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      809598459L

      • Serialized Fields

        • applicability
          Expression applicability
          An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements.
        • 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, for example "chronic" or "metastatic".
        • diseaseSymptomProcedure
          CodeableReference diseaseSymptomProcedure
          The situation that is being documented as an indicaton for this item.
        • duration
          DataType duration
          Timing or duration information, that may be associated with use with the indicated condition e.g. Adult patients suffering from myocardial infarction (from a few days until less than 35 days), ischaemic stroke (from 7 days until less than 6 months).
        • intendedEffect
          CodeableReference intendedEffect
          The intended effect, aim or strategy to be achieved.
        • otherTherapy
          List<ClinicalUseDefinition.ClinicalUseDefinitionContraindicationOtherTherapyComponent> otherTherapy
          Information about the use of the medicinal product in relation to other therapies described as part of the indication.
        • undesirableEffect
          List<Reference> undesirableEffect
          An unwanted side effect or negative outcome that may happen if you use the drug (or other subject of this resource) for this indication.

    • 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, product, food, substance etc. or laboratory test that interacts.

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

      class ClinicalUseDefinitionTypeEnumFactory extends Object implements Serializable

    • 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.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 its general class to 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 MetadataResource implements Serializable
      serialVersionUID:
      -937961842L

      • 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 CodeSystem.
        • 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<Enumerations.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.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • 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 last significantly changed. 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.
        • editor
          List<ContactDetail> editor
          An individual or organization primarily responsible for internal coherence of the CodeSystem.
        • effectivePeriod
          Period effectivePeriod
          The period during which the CodeSystem content was or is planned to be in active use.
        • endorser
          List<ContactDetail> endorser
          An individual or organization asserted by the publisher to be responsible for officially endorsing the CodeSystem for use in some setting.
        • 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.
        • 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 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 responsible for the release and ongoing maintenance of the code system.
        • purpose
          MarkdownType purpose
          Explanation of why this code system is needed and why it has been designed as it has.
        • relatedArtifact
          List<RelatedArtifact> relatedArtifact
          Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.
        • reviewer
          List<ContactDetail> reviewer
          An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the CodeSystem.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this code system. Enables tracking the life-cycle of the content.
        • 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.
        • topic
          List<CodeableConcept> topic
          Descriptions related to the content of the CodeSystem. Topics provide a high-level categorization as well as keywords for the CodeSystem that can be useful for filtering and searching.
        • 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 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 all codes in the code system independent of code status.
        • 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which CodeSystem is more current.
        • 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.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:
      -141147882L

      • Serialized Fields

        • additionalUse
          List<Coding> additionalUse
          Additional codes that detail how this designation would be used, if there is more than one use.
        • 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 multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.
        • 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:
      140986198L

      • 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 last significantly changed. 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 responsible for the release and ongoing maintenance of 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.
        • 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 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 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • Class org.hl7.fhir.r5.model.CompartmentDefinition.CompartmentDefinitionResourceComponent

      class CompartmentDefinitionResourceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1245370010L

      • Serialized Fields

        • code
          CodeType code
          The name of a resource supported by the server.
        • documentation
          StringType documentation
          Additional documentation about the resource and compartment.
        • endParam
          UriType endParam
          Search Parameter for mapping requests made with $everything.end (e.g. on [Patient.$everything](patient-operation-everything.html)).
        • 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,.
        • startParam
          UriType startParam
          Search Parameter for mapping requests made with $everything.start (e.g. on [Patient.$everything](patient-operation-everything.html)).

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

      class Composition extends DomainResource implements Serializable
      serialVersionUID:
      2030933035L

      • 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.
        • 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
          List<Identifier> identifier
          A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.
        • name
          StringType name
          A natural language name identifying the composition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • note
          List<Annotation> note
          For any additional notes.
        • 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
          List<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.
        • url
          UriType url
          An absolute URI that is used to identify this Composition 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 an authoritative instance of this Composition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Composition 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 Composition instances.
        • version
          StringType version
          An explicitly assigned identifer of a variation of the content in 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:
      -2108044093L

      • Serialized Fields

        • detail
          List<CodeableReference> detail
          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 case the procedure being documented is necessarily a "History and Physical" act. The events may be included as a code or as a reference to an other resource.
        • 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:
      902802086L

      • 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).
        • 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 MetadataResource implements Serializable
      serialVersionUID:
      1990005194L

      • Serialized Fields

        • additionalAttribute
          List<ConceptMap.AdditionalAttributeComponent> additionalAttribute
          An additionalAttribute defines an additional data element found in the source or target data model where the data will come from or be mapped to. Some mappings are based on data in addition to the source data element, where codes in multiple fields are combined to a single field (or vice versa).
        • 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 ConceptMap.
        • 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.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the concept map was last significantly changed. 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.
        • editor
          List<ContactDetail> editor
          An individual or organization primarily responsible for internal coherence of the ConceptMap.
        • effectivePeriod
          Period effectivePeriod
          The period during which the ConceptMap content was or is planned to be in active use.
        • endorser
          List<ContactDetail> endorser
          An individual or organization asserted by the publisher to be responsible for officially endorsing the ConceptMap for use in some setting.
        • 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.
        • 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 concept map. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • property
          List<ConceptMap.PropertyComponent> property
          A property defines a slot through which additional information can be provided about a map from source -> target.
        • publisher
          StringType publisher
          The name of the organization or individual responsible for the release and ongoing maintenance of the concept map.
        • purpose
          MarkdownType purpose
          Explanation of why this concept map is needed and why it has been designed as it has.
        • relatedArtifact
          List<RelatedArtifact> relatedArtifact
          Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.
        • reviewer
          List<ContactDetail> reviewer
          An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ConceptMap.
        • sourceScope
          DataType sourceScope
          Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings. Limits the scope of the map to source codes (ConceptMap.group.element code or valueSet) that are members of this value set.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this concept map. Enables tracking the life-cycle of the content.
        • targetScope
          DataType targetScope
          Identifier for the target value set that provides important context about how the mapping choices are made. Limits the scope of the map to target codes (ConceptMap.group.element.target code or valueSet) that are members of this value set.
        • title
          StringType title
          A short, descriptive, user-friendly title for the concept map.
        • topic
          List<CodeableConcept> topic
          Descriptions related to the content of the ConceptMap. Topics provide a high-level categorization as well as keywords for the ConceptMap that can be useful for filtering and searching.
        • 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 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which ConceptMap is more current.

    • Class org.hl7.fhir.r5.model.ConceptMap.AdditionalAttributeComponent

      class AdditionalAttributeComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1930701116L

      • Serialized Fields

        • code
          CodeType code
          A code that is used to identify this additional data attribute. The code is used internally in ConceptMap.group.element.target.dependsOn.attribute and ConceptMap.group.element.target.product.attribute.
        • description
          StringType description
          A description of the additional attribute and/or the data element it refers to - why it is defined, and how the value might be used in mappings, and a discussion of issues associated with the use of the data element.
        • type
          Enumeration<ConceptMap.ConceptMapAttributeType> type
          The type of the source data contained in this concept map for this data element.
        • uri
          UriType uri
          Reference to the formal definition of the source/target data element. For elements defined by the FHIR specification, or using a FHIR logical model, the correct format is {canonical-url}#{element-id}.

    • Class org.hl7.fhir.r5.model.ConceptMap.ConceptMapAttributeTypeEnumFactory

      class ConceptMapAttributeTypeEnumFactory extends Object implements Serializable

    • 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 and ConceptMap.group.element.noMap is not true. This provides the "default" to be applied when there is no target concept mapping specified or the expansion of ConceptMap.group.element.target.valueSet is empty.

    • Class org.hl7.fhir.r5.model.ConceptMap.ConceptMapGroupUnmappedComponent

      class ConceptMapGroupUnmappedComponent extends BackboneElement implements Serializable
      serialVersionUID:
      449945387L

      • Serialized Fields

        • code
          CodeType code
          The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code.
        • display
          StringType display
          The display for the code. The display is only provided to help editors when editing the concept map.
        • mode
          Enumeration<ConceptMap.ConceptMapGroupUnmappedMode> mode
          Defines which action to take if there is no match for the source concept in the target system designated for the group. One of 3 actions are possible: use the unmapped source 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).
        • otherMap
          CanonicalType otherMap
          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.
        • relationship
          Enumeration<Enumerations.ConceptMapRelationship> relationship
          The default relationship value to apply between the source and target concepts when the source code is unmapped and the mode is 'fixed' or 'use-source-code'.
        • valueSet
          CanonicalType valueSet
          The set of fixed codes to use when the mode = 'fixed' - all unmapped codes are mapped to each of the fixed codes.

    • Class org.hl7.fhir.r5.model.ConceptMap.ConceptMapGroupUnmappedModeEnumFactory

      class ConceptMapGroupUnmappedModeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.ConceptMap.ConceptMapPropertyTypeEnumFactory

      class ConceptMapPropertyTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.ConceptMap.MappingPropertyComponent

      class MappingPropertyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -422546419L

      • Serialized Fields

        • code
          CodeType code
          A reference to a mapping property defined in ConceptMap.property.
        • value
          DataType value
          The value of this property. If the type chosen for this element is 'code', then the property SHALL be defined in a ConceptMap.property element.

    • Class org.hl7.fhir.r5.model.ConceptMap.OtherElementComponent

      class OtherElementComponent extends BackboneElement implements Serializable
      serialVersionUID:
      2103818133L

      • Serialized Fields

        • attribute
          CodeType attribute
          A reference to the additional attribute that holds a value the map depends on.
        • value
          DataType value
          Data element value that the map depends on / produces.
        • valueSet
          CanonicalType valueSet
          This mapping applies if the data element value is a code from this value set.

    • Class org.hl7.fhir.r5.model.ConceptMap.PropertyComponent

      class PropertyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1693472150L

      • Serialized Fields

        • code
          CodeType code
          A code that is used to identify the property. The code is used internally (in ConceptMap.group.element.target.property.code) and also in the $translate operation.
        • description
          StringType description
          A description of the property - why it is defined, and how its value might be used.
        • system
          CanonicalType system
          The CodeSystem that defines the codes from which values of type ```code``` in property values.
        • type
          Enumeration<ConceptMap.ConceptMapPropertyType> type
          The type of the property value.
        • uri
          UriType uri
          Reference to the formal meaning of the property.

    • Class org.hl7.fhir.r5.model.ConceptMap.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<ConceptMap.TargetElementComponent> target
          A concept from the target value set that this concept maps to.
        • valueSet
          CanonicalType valueSet
          The set of concepts from the ConceptMap.group.source code system which are all being mapped to the target as part of this mapping rule.

    • Class org.hl7.fhir.r5.model.ConceptMap.TargetElementComponent

      class TargetElementComponent extends BackboneElement implements Serializable
      serialVersionUID:
      792559555L

      • 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 data attribute 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
          Product is the output of a ConceptMap that provides additional values that go in other attributes / data elemnts of the target data.
        • property
          List<ConceptMap.MappingPropertyComponent> property
          A property value for this source -> target mapping.
        • 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 concepts from the ConceptMap.group.target code system which are all being mapped to as part of this mapping rule. The effect of using this data element is the same as having multiple ConceptMap.group.element.target elements with one for each concept in the ConceptMap.group.element.target.valueSet value set.

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

      class Condition extends DomainResource implements Serializable
      serialVersionUID:
      -610903427L

      • 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.
        • 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<CodeableReference> 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.
        • participant
          List<Condition.ConditionParticipantComponent> participant
          Indicates who or what participated in the activities related to the condition and how they were involved.
        • recordedDate
          DateTimeType recordedDate
          The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.
        • 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.ConditionParticipantComponent

      class ConditionParticipantComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -576943815L

      • Serialized Fields

        • actor
          Reference actor
          Indicates who or what participated in the activities related to the condition.
        • function
          CodeableConcept function
          Distinguishes the type of involvement of the actor in the activities related to the condition.

    • 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:
      1055220331L

      • 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 last significantly changed. 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 responsible for the release and ongoing maintenance of 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 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • 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:
      -1133978742L

      • 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.
        • date
          DateType date
          Date the consent instance was agreed to.
        • decision
          Enumeration<Enumerations.ConsentProvisionType> decision
          Action to take - permit or deny - as default.
        • 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.
        • period
          Period period
          Effective period for this Consent Resource and all provisions unless specified in that provision.
        • policyBasis
          Consent.ConsentPolicyBasisComponent policyBasis
          A Reference or URL used to uniquely identify the policy the organization will enforce for this Consent. This Reference or URL should be specific to the version of the policy and should be dereferencable to a computable policy of some form.
        • policyText
          List<Reference> policyText
          A Reference to the human readable policy explaining the basis for the Consent.
        • provision
          List<Consent.ProvisionComponent> provision
          An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.
        • regulatoryBasis
          List<CodeableConcept> regulatoryBasis
          A set of codes that indicate the regulatory basis (if any) that this consent supports.
        • 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.ConsentPolicyBasisComponent

      class ConsentPolicyBasisComponent extends BackboneElement implements Serializable
      serialVersionUID:
      252506182L

      • Serialized Fields

        • reference
          Reference reference
          A Reference that identifies the policy the organization will enforce for this Consent.
        • url
          UrlType url
          A URL that links to a computable version of the policy the organization will enforce for this Consent.

    • 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 Grantor 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:
      -587666915L

      • Serialized Fields

        • action
          List<CodeableConcept> action
          Actions controlled by this provision.
        • actor
          List<Consent.ProvisionActorComponent> actor
          Who or what is controlled by this provision. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').
        • code
          List<CodeableConcept> code
          If this code is found in an instance, then the provision applies.
        • data
          List<Consent.ProvisionDataComponent> data
          The resources controlled by this provision if specific resources are referenced.
        • dataPeriod
          Period dataPeriod
          Clinical or Operational Relevant period of time that bounds the data controlled by this provision.
        • documentType
          List<Coding> documentType
          The documentType(s) covered by this provision. The type can be a CDA document, or some other type that indicates what sort of information the consent relates to.
        • expression
          Expression expression
          A computable (FHIRPath or other) definition of what is controlled by this consent.
        • period
          Period period
          Timeframe for this provision.
        • provision
          List<Consent.ProvisionComponent> provision
          Provisions which provide exceptions to the base provision or subprovisions.
        • 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 provision.
        • resourceType
          List<Coding> resourceType
          The resourceType(s) covered by this provision. The type can be a FHIR resource type or a profile on a type that indicates what information the consent relates to.
        • securityLabel
          List<Coding> securityLabel
          A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.

    • Class org.hl7.fhir.r5.model.Consent.ProvisionDataComponent

      class ProvisionDataComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1735979153L

      • Serialized Fields

        • meaning
          Enumeration<Enumerations.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 Provenance.entity indicates the target that was changed in the update (see [Provenance.entity](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
          A more detailed or qualifying explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state.
        • 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.
        • 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 the 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, warranty 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 last significantly changed. 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 may 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 specifies the applicable privacy and security policies governing this term and/or term elements.
        • classification
          Coding classification
          Security label privacy tag that specifies the level of confidentiality protection required for this term and/or term elements.
        • control
          List<Coding> control
          Security label privacy tag that specifies 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:
      -1129388911L

      • 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
          The identifier of the coverage as issued by the insurer.
        • insurancePlan
          Reference insurancePlan
          The insurance plan details, benefits and costs, which constitute this insurance coverage.
        • insurer
          Reference insurer
          The program or plan underwriter, payor, insurance company.
        • kind
          Enumeration<Coverage.Kind> kind
          The nature of the coverage be it insurance, or cash payment such as self-pay.
        • 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. For example; a patient might have (0) auto insurance (1) their own health insurance and (2) spouse's health insurance. When claiming for treatments which were not the result of an auto accident then only coverages (1) and (2) above would be applicatble and would apply in the order specified in parenthesis.
        • paymentBy
          List<Coverage.CoveragePaymentByComponent> paymentBy
          Link to the paying party and optionally what specifically they will be responsible to pay.
        • 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
          List<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:
      1395172201L

      • 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
          Identifier value
          The alphanumeric identifier associated with the insurer issued label.

    • Class org.hl7.fhir.r5.model.Coverage.CostToBeneficiaryComponent

      class CostToBeneficiaryComponent extends BackboneElement implements Serializable
      serialVersionUID:
      472499753L

      • Serialized Fields

        • category
          CodeableConcept category
          Code to identify the general type of benefits under which products and services are provided.
        • exception
          List<Coverage.ExemptionComponent> exception
          A suite of codes indicating exceptions or reductions to patient costs and their effective periods.
        • network
          CodeableConcept network
          Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.
        • term
          CodeableConcept term
          The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.
        • type
          CodeableConcept type
          The category of patient centric costs associated with treatment.
        • unit
          CodeableConcept unit
          Indicates if the benefits apply to an individual or to the family.
        • value
          DataType value
          The amount due from the patient for the cost category.

    • Class org.hl7.fhir.r5.model.Coverage.CoveragePaymentByComponent

      class CoveragePaymentByComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1279858336L

      • Serialized Fields

        • party
          Reference party
          The list of parties providing non-insurance payment for the treatment costs.
        • responsibility
          StringType responsibility
          Description of the financial responsibility.

    • 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.Coverage.KindEnumFactory

      class KindEnumFactory extends Object implements Serializable

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

      class CoverageEligibilityRequest extends DomainResource implements Serializable
      serialVersionUID:
      2008965302L

    • Class org.hl7.fhir.r5.model.CoverageEligibilityRequest.CoverageEligibilityRequestEventComponent

      class CoverageEligibilityRequestEventComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -634897375L

      • Serialized Fields

        • type
          CodeableConcept type
          A coded event such as when a service is expected or a card printed.
        • when
          DataType when
          A date or period in the past or future indicating when the event occurred or is expectd to occur.

    • 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:
      1099912055L

    • 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.CoverageEligibilityResponseEventComponent

      class CoverageEligibilityResponseEventComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -634897375L

      • Serialized Fields

        • type
          CodeableConcept type
          A coded event such as when a service is expected or a card printed.
        • when
          DataType when
          A date or period in the past or future indicating when the event occurred or is expectd to occur.

    • 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:
      -344349215L

      • Serialized Fields

        • code
          CodeableConcept code
          An error code,from a specified code system, which details why the eligibility check could not be performed.
        • expression
          List<StringType> expression
          A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.

    • 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:
      -2078097376L

      • 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 resolvable 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.FHIRTypes> 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.
        • valueFilter
          List<DataRequirement.DataRequirementValueFilterComponent> valueFilter
          Value filters specify additional constraints on the data for elements other than code-valued or date-valued. Each value filter specifies an additional constraint on the data (i.e. valueFilters are AND'ed, not OR'ed).

    • 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 resolvable 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 resolvable 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.DataRequirementValueFilterComponent

      class DataRequirementValueFilterComponent extends Element implements Serializable
      serialVersionUID:
      2106988483L

      • Serialized Fields

        • comparator
          Enumeration<DataRequirement.ValueFilterComparator> comparator
          The comparator to be used to determine whether the value is matching.
        • path
          StringType path
          The attribute of the filter. The specified path SHALL be a FHIRPath resolvable 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 a type that is comparable to the valueFilter.value[x] element for the filter.
        • searchParam
          StringType searchParam
          A search parameter defined on the specified type of the DataRequirement, and which searches on elements of a type compatible with the type of the valueFilter.value[x] for the filter.
        • value
          DataType value
          The value of the filter.

    • Class org.hl7.fhir.r5.model.DataRequirement.SortDirectionEnumFactory

      class SortDirectionEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.DataRequirement.ValueFilterComparatorEnumFactory

      class ValueFilterComparatorEnumFactory 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:
      1031242519L

      • 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.
        • category
          List<CodeableConcept> category
          A code that classifies the general type of detected issue.
        • code
          CodeableConcept code
          Identifies the specific type of issue identified.
        • detail
          MarkdownType detail
          A textual explanation of the detected issue.
        • encounter
          Reference encounter
          The encounter during which this issue was detected.
        • 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.
        • reference
          UriType reference
          The literature, knowledge-base or similar reference that describes the propensity for the detected issue identified.
        • severity
          Enumeration<DetectedIssue.DetectedIssueSeverity> severity
          Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.
        • status
          Enumeration<DetectedIssue.DetectedIssueStatus> status
          Indicates the status of the detected issue.
        • subject
          Reference subject
          Indicates the subject whose record the detected issue is associated with.

    • 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:
      1504361133L

      • 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.
        • note
          List<Annotation> note
          Clinicians may add additional notes or justifications about the mitigation action. For example, patient can have this drug because they have had it before without any issues. Multiple justifications may be provided.

    • Class org.hl7.fhir.r5.model.DetectedIssue.DetectedIssueSeverityEnumFactory

      class DetectedIssueSeverityEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.DetectedIssue.DetectedIssueStatusEnumFactory

      class DetectedIssueStatusEnumFactory extends Object implements Serializable

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

      class Device extends DomainResource implements Serializable
      serialVersionUID:
      2120085847L

      • Serialized Fields

        • availabilityStatus
          CodeableConcept availabilityStatus
          The availability of the device.
        • biologicalSourceEvent
          Identifier biologicalSourceEvent
          An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled.
        • category
          List<CodeableConcept> category
          Devices may be associated with one or more categories.
        • conformsTo
          List<Device.DeviceConformsToComponent> conformsTo
          Identifies the standards, specifications, or formal guidances for the capabilities supported by the device. The device may be certified as conformant to these specifications e.g., communication, performance, process, measurement, or specialization standards.
        • contact
          List<ContactPoint> contact
          Contact details for an organization or a particular human that is responsible for the device.
        • cycle
          Count cycle
          The series of occurrences that repeats during the operation of the device.
        • definition
          CodeableReference definition
          The reference to the definition for the device.
        • 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.name, or may be another simple name.
        • duration
          Duration duration
          A measurement of time during the device's operation (e.g., days, hours, mins, etc.).
        • 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).
        • gateway
          List<CodeableReference> gateway
          The linked device acting as a communication controller, data collector, translator, or concentrator for the current device (e.g., mobile phone application that relays a blood pressure device's data).
        • identifier
          List<Identifier> identifier
          Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
        • location
          Reference location
          The place where the device can be found.
        • 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.
        • mode
          CodeableConcept mode
          The designated condition for performing a task with the device.
        • modelNumber
          StringType modelNumber
          The manufacturer's model number for the device.
        • name
          List<Device.DeviceNameComponent> name
          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.
        • note
          List<Annotation> note
          Descriptive information, usage information or implantation information that is not captured in an existing element.
        • owner
          Reference owner
          An organization that is responsible for the provision and ongoing maintenance of the device.
        • parent
          Reference parent
          The higher level or encompassing device that this device is a logical part of.
        • partNumber
          StringType partNumber
          The part number or catalog number of the device.
        • property
          List<Device.DevicePropertyComponent> property
          Static or essentially fixed characteristics or features of the device (e.g., time or timing attributes, resolution, accuracy, intended use or instructions for use, and physical attributes) that are not otherwise captured in more specific attributes.
        • 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
          The Device record status. This is not the status of the device like availability.
        • 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.DeviceConformsToComponent

      class DeviceConformsToComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1592712180L

      • Serialized Fields

        • category
          CodeableConcept category
          Describes the type of the standard, specification, or formal guidance.
        • specification
          CodeableConcept specification
          Code that identifies the specific standard, specification, protocol, formal guidance, regulation, legislation, or certification scheme to which the device adheres.
        • version
          StringType version
          Identifies the specific form or variant of the standard, specification, or formal guidance. This may be a 'version number', release, document edition, publication year, or other label.

    • Class org.hl7.fhir.r5.model.Device.DeviceNameComponent

      class DeviceNameComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1911928470L

      • Serialized Fields

    • 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, such as resolution, color, size, being represented.
        • value
          DataType value
          The value of the property specified by the associated property.type code.

    • 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:
      1358422741L

      • Serialized Fields

        • component
          Identifier component
          The hardware or software module of the device to which the version applies.
        • installDate
          DateTimeType installDate
          The date the version was installed on the device.
        • 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.DeviceAssociation

      class DeviceAssociation extends DomainResource implements Serializable
      serialVersionUID:
      1892071017L

      • Serialized Fields

        • bodyStructure
          Reference bodyStructure
          Current anatomical location of the device in/on subject.
        • category
          List<CodeableConcept> category
          Describes the relationship between the device and subject.
        • device
          Reference device
          Reference to the devices associated with the patient or group.
        • identifier
          List<Identifier> identifier
          Instance identifier.
        • operation
          List<DeviceAssociation.DeviceAssociationOperationComponent> operation
          The details about the device when it is in use to describe its operation.
        • period
          Period period
          Begin and end dates and times for the device association.
        • status
          CodeableConcept status
          Indicates the state of the Device association.
        • statusReason
          List<CodeableConcept> statusReason
          The reasons given for the current association status.
        • subject
          Reference subject
          The individual, group of individuals or device that the device is on or associated with.

    • Class org.hl7.fhir.r5.model.DeviceAssociation.DeviceAssociationOperationComponent

      class DeviceAssociationOperationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1587836408L

      • Serialized Fields

        • operator
          List<Reference> operator
          The individual performing the action enabled by the device.
        • period
          Period period
          Begin and end dates and times for the device's operation.
        • status
          CodeableConcept status
          Device operational condition corresponding to the association.

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

      class DeviceDefinition extends DomainResource implements Serializable
      serialVersionUID:
      -260935704L

    • 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.DeviceDefinitionConformsToComponent

      class DeviceDefinitionConformsToComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -370906560L

      • Serialized Fields

        • category
          CodeableConcept category
          Describes the type of the standard, specification, or formal guidance.
        • source
          List<RelatedArtifact> source
          Standard, regulation, certification, or guidance website, document, or other publication, or similar, supporting the conformance.
        • specification
          CodeableConcept specification
          Code that identifies the specific standard, specification, protocol, formal guidance, regulation, legislation, or certification scheme to which the device adheres.
        • version
          List<StringType> version
          Identifies the specific form or variant of the standard, specification, or formal guidance. This may be a 'version number', release, document edition, publication year, or other label.

    • 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:
      -1323961659L

      • Serialized Fields

        • contraindication
          List<CodeableConcept> contraindication
          A specific situation when a device should not be used because it may cause harm.
        • indication
          List<CodeableConcept> 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<CodeableConcept> 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:
      1022373074L

    • 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 such as a resolution or color being represented.
        • value
          DataType value
          The value of the property specified by the associated property.type code.

    • Class org.hl7.fhir.r5.model.DeviceDefinition.DeviceDefinitionRegulatoryIdentifierComponent

      class DeviceDefinitionRegulatoryIdentifierComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1438058623L

    • Class org.hl7.fhir.r5.model.DeviceDefinition.DeviceDefinitionRegulatoryIdentifierTypeEnumFactory

      class DeviceDefinitionRegulatoryIdentifierTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.DeviceDefinition.DeviceDefinitionUdiDeviceIdentifierComponent

      class DeviceDefinitionUdiDeviceIdentifierComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1819796108L

      • 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.UdiDeviceIdentifierMarketDistributionComponent> marketDistribution
          Indicates where and when the device is available on the market.

    • 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.DeviceDefinition.PackagingDistributorComponent

      class PackagingDistributorComponent 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.UdiDeviceIdentifierMarketDistributionComponent

      class UdiDeviceIdentifierMarketDistributionComponent 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.DeviceDispense

      class DeviceDispense extends DomainResource implements Serializable
      serialVersionUID:
      1740231007L

      • 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.
        • receiver
          Reference receiver
          Identifies the person who picked up the device or the person or location where the device was delivered. This may be a patient or their caregiver, but some cases exist where it can be a healthcare professional or a location.
        • 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
          MarkdownType 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:
      2109169775L

      • 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
          CodeType color
          The preferred color associated with the metric (e.g., display color). 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; the metrics are displayed in different characteristic colors, such as HR in blue, BP in green, and PR and SpO2 in magenta.
        • device
          Reference device
          Describes the link to the Device. This is also known as a channel device.
        • identifier
          List<Identifier> identifier
          Instance identifiers assigned to a device, by the device or gateway software, manufacturers, other organizations or owners. For example, handle ID.
        • measurementFrequency
          Quantity measurementFrequency
          The frequency at which the metric is taken or recorded. Devices measure metrics at a wide range of frequencies; for example, an ECG might sample measurements in the millisecond range, while an NIBP might trigger only once an hour. Less often, the measurementFrequency may be based on a unit other than time, such as distance (e.g. for a measuring wheel). The update period may be different than the measurement frequency, 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.
        • 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.DeviceMetricOperationalStatusEnumFactory

      class DeviceMetricOperationalStatusEnumFactory extends Object implements Serializable

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

      class DeviceRequest extends DomainResource implements Serializable
      serialVersionUID:
      1768564436L

      • Serialized Fields

        • asNeeded
          BooleanType asNeeded
          This status is to indicate whether the request is a PRN or may be given as needed.
        • asNeededFor
          CodeableConcept asNeededFor
          The reason for using the device.
        • 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
          A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.
        • 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
          CodeableReference performer
          The desired 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.
        • 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.
        • replaces
          List<Reference> replaces
          The request takes the place of the referenced completed or terminated request(s).
        • 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:
      -10803928L

      • Serialized Fields

        • adherence
          DeviceUsage.DeviceUsageAdherenceComponent adherence
          This indicates how or if the device is being used.
        • 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.DeviceUsageAdherenceComponent

      class DeviceUsageAdherenceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1932336797L

    • 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:
      -530178625L

      • 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
          A code or name that describes this diagnostic report.
        • composition
          Reference composition
          Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport.
        • conclusion
          MarkdownType conclusion
          Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.
        • conclusionCode
          List<CodeableConcept> conclusionCode
          One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.
        • effective
          DataType effective
          The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.
        • encounter
          Reference encounter
          The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.
        • identifier
          List<Identifier> identifier
          Identifiers assigned to this report by the performer or other systems.
        • issued
          InstantType issued
          The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified.
        • media
          List<DiagnosticReport.DiagnosticReportMediaComponent> media
          A list of key images or data associated with this report. The images or data are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).
        • note
          List<Annotation> note
          Comments about the diagnostic report.
        • performer
          List<Reference> performer
          The diagnostic service that is responsible for issuing the report.
        • presentedForm
          List<Attachment> presentedForm
          Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.
        • result
          List<Reference> result
          [Observations](observation.html) that are part of this diagnostic report.
        • resultsInterpreter
          List<Reference> resultsInterpreter
          The practitioner or organization that is responsible for the report's conclusions and interpretations.
        • specimen
          List<Reference> specimen
          Details about the specimens on which this diagnostic report is based.
        • status
          Enumeration<DiagnosticReport.DiagnosticReportStatus> status
          The status of the diagnostic report.
        • study
          List<Reference> study
          One or more links to full details of any study performed during the diagnostic investigation. An ImagingStudy might comprise a set of radiologic images obtained via a procedure that are analyzed as a group. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images. A GenomicStudy might comprise one or more analyses, each serving a specific purpose. These analyses may vary in method (e.g., karyotyping, CNV, or SNV detection), performer, software, devices used, or regions targeted.
        • subject
          Reference subject
          The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.
        • supportingInfo
          List<DiagnosticReport.DiagnosticReportSupportingInfoComponent> supportingInfo
          This backbone element contains supporting information that was used in the creation of the report not included in the results already included in the report.

    • Class org.hl7.fhir.r5.model.DiagnosticReport.DiagnosticReportMediaComponent

      class DiagnosticReportMediaComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1827561947L

      • Serialized Fields

        • comment
          StringType comment
          A comment about the image or data. Typically, this is used to provide an explanation for why the image or data is included, or to draw the viewer's attention to important features.
        • link
          Reference link
          Reference to the image or data source.

    • Class org.hl7.fhir.r5.model.DiagnosticReport.DiagnosticReportStatusEnumFactory

      class DiagnosticReportStatusEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.DiagnosticReport.DiagnosticReportSupportingInfoComponent

      class DiagnosticReportSupportingInfoComponent extends BackboneElement implements Serializable
      serialVersionUID:
      492391425L

      • Serialized Fields

        • reference
          Reference reference
          The reference for the supporting information in the diagnostic report.
        • type
          CodeableConcept type
          The code value for the role of the supporting information in the diagnostic report.

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

      class Distance extends Quantity implements Serializable
      serialVersionUID:
      0L

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

      class DocumentReference extends DomainResource implements Serializable
      serialVersionUID:
      -981268007L

      • Serialized Fields

        • attester
          List<DocumentReference.DocumentReferenceAttesterComponent> attester
          A participant who has authenticated the accuracy of the document.
        • author
          List<Reference> author
          Identifies who is responsible for adding the information to the document.
        • basedOn
          List<Reference> basedOn
          A procedure that is fulfilled in whole or in part by the creation of this media.
        • bodySite
          List<CodeableReference> bodySite
          The anatomic structures included in the document.
        • category
          List<CodeableConcept> category
          A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.
        • content
          List<DocumentReference.DocumentReferenceContentComponent> content
          The document and format referenced. If there are multiple content element repetitions, these must all represent the same document in different format, or attachment metadata.
        • context
          List<Reference> context
          Describes the clinical encounter or type of care that the document content is associated with.
        • custodian
          Reference custodian
          Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.
        • date
          InstantType date
          When the document reference was created.
        • description
          MarkdownType description
          Human-readable description of the source document.
        • docStatus
          Enumeration<Enumerations.CompositionStatus> docStatus
          The status of the underlying document.
        • event
          List<CodeableReference> event
          This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.
        • facilityType
          CodeableConcept facilityType
          The kind of facility where the patient was seen.
        • identifier
          List<Identifier> identifier
          Other business identifiers associated with the document, including version independent identifiers.
        • modality
          List<CodeableConcept> modality
          Imaging modality used. This may include both acquisition and non-acquisition modalities.
        • period
          Period period
          The time period over which the service that is described by the document was provided.
        • practiceSetting
          CodeableConcept practiceSetting
          This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.
        • relatesTo
          List<DocumentReference.DocumentReferenceRelatesToComponent> relatesTo
          Relationships that this document has with other document references that already exist.
        • securityLabel
          List<CodeableConcept> securityLabel
          A set of Security-Tag codes specifying the level of privacy/security of the Document found at DocumentReference.content.attachment.url. Note that DocumentReference.meta.security contains the security labels of the data elements in DocumentReference, while DocumentReference.securityLabel contains the security labels for the document the reference refers to. The distinction recognizes that the document may contain sensitive information, while the DocumentReference is metadata about the document and thus might not be as sensitive as the document. For example: a psychotherapy episode may contain highly sensitive information, while the metadata may simply indicate that some episode happened.
        • status
          Enumeration<DocumentReference.DocumentReferenceStatus> status
          The status of this document reference.
        • subject
          Reference subject
          Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).
        • type
          CodeableConcept type
          Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.
        • version
          StringType version
          An explicitly assigned identifer of a variation of the content in the DocumentReference.

    • Class org.hl7.fhir.r5.model.DocumentReference.DocumentReferenceAttesterComponent

      class DocumentReferenceAttesterComponent extends BackboneElement implements Serializable
      serialVersionUID:
      545132751L

      • Serialized Fields

        • mode
          CodeableConcept mode
          The type of attestation the authenticator offers.
        • party
          Reference party
          Who attested the document in the specified way.
        • time
          DateTimeType time
          When the document was attested by the party.

    • Class org.hl7.fhir.r5.model.DocumentReference.DocumentReferenceContentComponent

      class DocumentReferenceContentComponent extends BackboneElement implements Serializable
      serialVersionUID:
      174089424L

      • Serialized Fields

        • attachment
          Attachment attachment
          The document or URL of the document along with critical metadata to prove content has integrity.
        • profile
          List<DocumentReference.DocumentReferenceContentProfileComponent> profile
          An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.

    • Class org.hl7.fhir.r5.model.DocumentReference.DocumentReferenceContentProfileComponent

      class DocumentReferenceContentProfileComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1135414639L

      • Serialized Fields

        • value
          DataType value
          Code|uri|canonical.

    • Class org.hl7.fhir.r5.model.DocumentReference.DocumentReferenceRelatesToComponent

      class DocumentReferenceRelatesToComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -372012026L

      • Serialized Fields

        • code
          CodeableConcept code
          The type of relationship that this document has with anther document.
        • target
          Reference target
          The target document of this relationship.

    • Class org.hl7.fhir.r5.model.DocumentReference.DocumentReferenceStatusEnumFactory

      class DocumentReferenceStatusEnumFactory extends Object implements Serializable

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

      class DomainResource extends Resource implements Serializable
      serialVersionUID:
      -970285559L

      • Serialized Fields

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

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

      class Dosage extends BackboneType implements Serializable
      serialVersionUID:
      386091152L

      • Serialized Fields

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

    • Class org.hl7.fhir.r5.model.Dosage.DosageDoseAndRateComponent

      class DosageDoseAndRateComponent extends Element implements Serializable
      serialVersionUID:
      230646604L

      • Serialized Fields

        • dose
          DataType dose
          Amount of medication per dose.
        • rate
          DataType rate
          Amount of medication per unit of time.
        • type
          CodeableConcept type
          The kind of dose or rate specified, for example, ordered or calculated.

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

      class Duration extends Quantity implements Serializable
      serialVersionUID:
      0L

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

      class Element extends Base implements Serializable
      serialVersionUID:
      -1452745816L

      • Serialized Fields

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

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

      class ElementDefinition extends BackboneType implements Serializable
      serialVersionUID:
      -1474105308L

      • Serialized Fields

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

    • Class org.hl7.fhir.r5.model.ElementDefinition.AdditionalBindingPurposeVSEnumFactory

      class AdditionalBindingPurposeVSEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.ElementDefinition.AggregationModeEnumFactory

      class AggregationModeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.ElementDefinition.ConstraintSeverityEnumFactory

      class ConstraintSeverityEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.ElementDefinition.DiscriminatorTypeEnumFactory

      class DiscriminatorTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.ElementDefinition.ElementDefinitionBaseComponent

      class ElementDefinitionBaseComponent extends Element implements Serializable
      serialVersionUID:
      -1412704221L

      • Serialized Fields

        • max
          StringType max
          Maximum cardinality of the base element identified by the path.
        • min
          UnsignedIntType min
          Minimum cardinality of the base element identified by the path.
        • path
          StringType path
          The Path that identifies the base element - this matches the ElementDefinition.path for that element. Across FHIR, there is only one base definition of any element - that is, an element definition on a [StructureDefinition](structuredefinition.html#) without a StructureDefinition.base.

    • Class org.hl7.fhir.r5.model.ElementDefinition.ElementDefinitionBindingAdditionalComponent

      class ElementDefinitionBindingAdditionalComponent extends Element implements Serializable
      serialVersionUID:
      -1312796441L

      • Serialized Fields

        • any
          BooleanType any
          Whether the binding applies to all repeats, or just to any one of them. This is only relevant for elements that can repeat.
        • documentation
          MarkdownType documentation
          Documentation of the purpose of use of the bindingproviding additional information about how it is intended to be used.
        • purpose
          Enumeration<ElementDefinition.AdditionalBindingPurposeVS> purpose
          The use of this additional binding.
        • shortDoco
          StringType shortDoco
          Concise documentation - for summary tables.
        • usage
          List<UsageContext> usage
          Qualifies the usage of the binding. Typically bindings are qualified by jurisdiction, but they may also be qualified by gender, workflow status, clinical domain etc. The information to decide whether a usege context applies is usually outside the resource, determined by context, and this might present challenges for validation tooling.
        • valueSet
          CanonicalType valueSet
          The valueSet that is being bound for the purpose.

    • Class org.hl7.fhir.r5.model.ElementDefinition.ElementDefinitionBindingComponent

      class ElementDefinitionBindingComponent extends Element implements Serializable
      serialVersionUID:
      16276611L

      • Serialized Fields

        • additional
          List<ElementDefinition.ElementDefinitionBindingAdditionalComponent> additional
          Additional bindings that help applications implementing this element. Additional bindings do not replace the main binding but provide more information and/or context.
        • description
          MarkdownType description
          Describes the intended use of this particular set of codes.
        • strength
          Enumeration<Enumerations.BindingStrength> strength
          Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.
        • valueSet
          CanonicalType valueSet
          Refers to the value set that identifies the set of codes the binding refers to.

    • Class org.hl7.fhir.r5.model.ElementDefinition.ElementDefinitionConstraintComponent

      class ElementDefinitionConstraintComponent extends Element implements Serializable
      serialVersionUID:
      1642607838L

      • Serialized Fields

        • expression
          StringType expression
          A [FHIRPath](fhirpath.html) expression of constraint that can be executed to see if this constraint is met.
        • human
          StringType human
          Text that can be used to describe the constraint in messages identifying that the constraint has been violated.
        • key
          IdType key
          Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.
        • requirements
          MarkdownType requirements
          Description of why this constraint is necessary or appropriate.
        • severity
          Enumeration<ElementDefinition.ConstraintSeverity> severity
          Identifies the impact constraint violation has on the conformance of the instance.
        • source
          CanonicalType source
          A reference to the original source of the constraint, for traceability purposes.
        • suppress
          BooleanType suppress
          If true, indicates that the warning or best practice guideline should be suppressed.

    • Class org.hl7.fhir.r5.model.ElementDefinition.ElementDefinitionExampleComponent

      class ElementDefinitionExampleComponent extends Element implements Serializable
      serialVersionUID:
      463190922L

      • Serialized Fields

        • label
          StringType label
          Describes the purpose of this example among the set of examples.
        • value
          DataType value
          The actual value for the element, which must be one of the types allowed for this element.

    • Class org.hl7.fhir.r5.model.ElementDefinition.ElementDefinitionMappingComponent

      class ElementDefinitionMappingComponent extends Element implements Serializable
      serialVersionUID:
      -582458727L

      • Serialized Fields

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

    • Class org.hl7.fhir.r5.model.ElementDefinition.ElementDefinitionSlicingComponent

      class ElementDefinitionSlicingComponent extends Element implements Serializable
      serialVersionUID:
      -311635839L

      • Serialized Fields

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

    • Class org.hl7.fhir.r5.model.ElementDefinition.ElementDefinitionSlicingDiscriminatorComponent

      class ElementDefinitionSlicingDiscriminatorComponent extends Element implements Serializable
      serialVersionUID:
      1151159293L

      • Serialized Fields

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

    • Class org.hl7.fhir.r5.model.ElementDefinition.PropertyRepresentationEnumFactory

      class PropertyRepresentationEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.ElementDefinition.ReferenceVersionRulesEnumFactory

      class ReferenceVersionRulesEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.ElementDefinition.SlicingRulesEnumFactory

      class SlicingRulesEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.ElementDefinition.TypeRefComponent

      class TypeRefComponent extends Element implements Serializable
      serialVersionUID:
      957891653L

      • Serialized Fields

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

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

      class Encounter extends DomainResource implements Serializable
      serialVersionUID:
      -1336316477L

      • Serialized Fields

        • account
          List<Reference> account
          The set of accounts that may be used for billing for this Encounter.
        • actualPeriod
          Period actualPeriod
          The actual start and end time of the encounter.
        • admission
          Encounter.EncounterAdmissionComponent admission
          Details about the stay during which a healthcare service is provided. This does not describe the event of admitting the patient, but rather any information that is relevant from the time of admittance until the time of discharge.
        • appointment
          List<Reference> appointment
          The appointment that scheduled this encounter.
        • basedOn
          List<Reference> basedOn
          The request this encounter satisfies (e.g. incoming referral or procedure request).
        • careTeam
          List<Reference> careTeam
          The group(s) of individuals, organizations that are allocated to participate in this encounter. The participants backbone will record the actuals of when these individuals participated during the encounter.
        • class_
          List<CodeableConcept> class_
          Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
        • diagnosis
          List<Encounter.DiagnosisComponent> diagnosis
          The list of diagnosis relevant to this encounter.
        • dietPreference
          List<CodeableConcept> dietPreference
          Diet preferences reported by the patient.
        • episodeOfCare
          List<Reference> episodeOfCare
          Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).
        • identifier
          List<Identifier> identifier
          Identifier(s) by which this encounter is known.
        • length
          Duration length
          Actual quantity of time the encounter lasted. This excludes the time during leaves of absence. When missing it is the time in between the start and end values.
        • location
          List<Encounter.EncounterLocationComponent> location
          List of locations where the patient has been during this encounter.
        • participant
          List<Encounter.EncounterParticipantComponent> participant
          The list of people responsible for providing the service.
        • partOf
          Reference partOf
          Another Encounter of which this encounter is a part of (administratively or in time).
        • plannedEndDate
          DateTimeType plannedEndDate
          The planned end date/time (or discharge date) of the encounter.
        • plannedStartDate
          DateTimeType plannedStartDate
          The planned start date/time (or admission date) of the encounter.
        • priority
          CodeableConcept priority
          Indicates the urgency of the encounter.
        • reason
          List<Encounter.ReasonComponent> reason
          The list of medical reasons that are expected to be addressed during the episode of care.
        • serviceProvider
          Reference serviceProvider
          The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the colonoscopy example on the Encounter examples tab.
        • serviceType
          List<CodeableReference> serviceType
          Broad categorization of the service that is to be provided (e.g. cardiology).
        • specialArrangement
          List<CodeableConcept> specialArrangement
          Any special requests that have been made for this encounter, such as the provision of specific equipment or other things.
        • specialCourtesy
          List<CodeableConcept> specialCourtesy
          Special courtesies that may be provided to the patient during the encounter (VIP, board member, professional courtesy).
        • status
          Enumeration<Enumerations.EncounterStatus> status
          The current state of the encounter (not the state of the patient within the encounter - that is subjectState).
        • subject
          Reference subject
          The patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam.
        • subjectStatus
          CodeableConcept subjectStatus
          The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.
        • type
          List<CodeableConcept> type
          Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
        • virtualService
          List<VirtualServiceDetail> virtualService
          Connection details of a virtual service (e.g. conference call).

    • Class org.hl7.fhir.r5.model.Encounter.DiagnosisComponent

      class DiagnosisComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1029565663L

      • Serialized Fields

        • condition
          List<CodeableReference> condition
          The coded diagnosis or a reference to a Condition (with other resources referenced in the evidence.detail), the use property will indicate the purpose of this specific diagnosis.
        • use
          List<CodeableConcept> use
          Role that this diagnosis has within the encounter (e.g. admission, billing, discharge ?).

    • Class org.hl7.fhir.r5.model.Encounter.EncounterAdmissionComponent

      class EncounterAdmissionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1702856594L

      • Serialized Fields

        • admitSource
          CodeableConcept admitSource
          From where patient was admitted (physician referral, transfer).
        • destination
          Reference destination
          Location/organization to which the patient is discharged.
        • dischargeDisposition
          CodeableConcept dischargeDisposition
          Category or kind of location after discharge.
        • origin
          Reference origin
          The location/organization from which the patient came before admission.
        • preAdmissionIdentifier
          Identifier preAdmissionIdentifier
          Pre-admission identifier.
        • reAdmission
          CodeableConcept reAdmission
          Indicates that this encounter is directly related to a prior admission, often because the conditions addressed in the prior admission were not fully addressed.

    • Class org.hl7.fhir.r5.model.Encounter.EncounterLocationComponent

      class EncounterLocationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1665957440L

      • Serialized Fields

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

    • Class org.hl7.fhir.r5.model.Encounter.EncounterLocationStatusEnumFactory

      class EncounterLocationStatusEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Encounter.EncounterParticipantComponent

      class EncounterParticipantComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1982623707L

      • Serialized Fields

        • actor
          Reference actor
          Person involved in the encounter, the patient/group is also included here to indicate that the patient was actually participating in the encounter. Not including the patient here covers use cases such as a case meeting between practitioners about a patient - non contact times.
        • period
          Period period
          The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.
        • type
          List<CodeableConcept> type
          Role of participant in encounter.

    • Class org.hl7.fhir.r5.model.Encounter.ReasonComponent

      class ReasonComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1305979913L

      • Serialized Fields

        • use
          List<CodeableConcept> use
          What the reason value should be used as e.g. Chief Complaint, Health Concern, Health Maintenance (including screening).
        • value
          List<CodeableReference> value
          Reason the encounter takes place, expressed as a code or a reference to another resource. For admissions, this can be used for a coded admission diagnosis.

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

      class EncounterHistory extends DomainResource implements Serializable
      serialVersionUID:
      775989939L

      • Serialized Fields

        • actualPeriod
          Period actualPeriod
          The start and end time associated with this set of values associated with the encounter, may be different to the planned times for various reasons.
        • class_
          CodeableConcept class_
          Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
        • encounter
          Reference encounter
          The Encounter associated with this set of historic values.
        • identifier
          List<Identifier> identifier
          Identifier(s) by which this encounter is known.
        • length
          Duration length
          Actual quantity of time the encounter lasted. This excludes the time during leaves of absence. When missing it is the time in between the start and end values.
        • location
          List<EncounterHistory.EncounterHistoryLocationComponent> location
          The location of the patient at this point in the encounter, the multiple cardinality permits de-normalizing the levels of the location hierarchy, such as site/ward/room/bed.
        • plannedEndDate
          DateTimeType plannedEndDate
          The planned end date/time (or discharge date) of the encounter.
        • plannedStartDate
          DateTimeType plannedStartDate
          The planned start date/time (or admission date) of the encounter.
        • serviceType
          List<CodeableReference> serviceType
          Broad categorization of the service that is to be provided (e.g. cardiology).
        • status
          Enumeration<Enumerations.EncounterStatus> status
          planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown.
        • subject
          Reference subject
          The patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam.
        • subjectStatus
          CodeableConcept subjectStatus
          The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.
        • type
          List<CodeableConcept> type
          Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).

    • Class org.hl7.fhir.r5.model.EncounterHistory.EncounterHistoryLocationComponent

      class EncounterHistoryLocationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1306742681L

      • Serialized Fields

        • form
          CodeableConcept form
          This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query.
        • location
          Reference location
          The location where the encounter takes place.

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

      class Endpoint extends DomainResource implements Serializable
      serialVersionUID:
      1633700267L

      • Serialized Fields

        • address
          UrlType address
          The uri that describes the actual end-point to connect to.
        • connectionType
          List<CodeableConcept> connectionType
          A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).
        • contact
          List<ContactPoint> contact
          Contact details for a human to contact about the endpoint. The primary use of this for system administrator troubleshooting.
        • description
          StringType description
          The description of the endpoint and what it is for (typically used as supplemental information in an endpoint directory describing its usage/purpose).
        • environmentType
          List<CodeableConcept> environmentType
          The type of environment(s) exposed at this endpoint (dev, prod, test, etc.).
        • header
          List<StringType> header
          Additional headers / information to send as part of the notification.
        • identifier
          List<Identifier> identifier
          Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
        • managingOrganization
          Reference managingOrganization
          The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).
        • name
          StringType name
          A friendly name that this endpoint can be referred to with.
        • payload
          List<Endpoint.EndpointPayloadComponent> payload
          The set of payloads that are provided/available at this endpoint.
        • period
          Period period
          The interval during which the endpoint is expected to be operational.
        • status
          Enumeration<Endpoint.EndpointStatus> status
          The endpoint status represents the general expected availability of an endpoint.

    • Class org.hl7.fhir.r5.model.Endpoint.EndpointPayloadComponent

      class EndpointPayloadComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1398955844L

      • Serialized Fields

        • mimeType
          List<CodeType> mimeType
          The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).
        • type
          List<CodeableConcept> type
          The payload type describes the acceptable content that can be communicated on the endpoint.

    • Class org.hl7.fhir.r5.model.Endpoint.EndpointStatusEnumFactory

      class EndpointStatusEnumFactory extends Object implements Serializable

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

      class EnrollmentRequest extends DomainResource implements Serializable
      serialVersionUID:
      1033959125L

      • Serialized Fields

        • candidate
          Reference candidate
          Patient Resource.
        • coverage
          Reference coverage
          Reference to the program or plan identification, underwriter or payor.
        • created
          DateTimeType created
          The date when this resource was created.
        • identifier
          List<Identifier> identifier
          The Response business identifier.
        • insurer
          Reference insurer
          The Insurer who is target of the request.
        • provider
          Reference provider
          The practitioner who is responsible for the services rendered to the patient.
        • status
          Enumeration<Enumerations.FinancialResourceStatusCodes> status
          The status of the resource instance.

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

      class EnrollmentResponse extends DomainResource implements Serializable
      serialVersionUID:
      -1503790623L

    • Class org.hl7.fhir.r5.model.EnrollmentResponse.EnrollmentOutcomeEnumFactory

      class EnrollmentOutcomeEnumFactory extends Object implements Serializable

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

      class Enumeration extends PrimitiveType<T extends Enum<?>> implements Externalizable
      serialVersionUID:
      1L

    • Class org.hl7.fhir.r5.model.Enumerations.ActionCardinalityBehaviorEnumFactory

      class ActionCardinalityBehaviorEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.ActionConditionKindEnumFactory

      class ActionConditionKindEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.ActionGroupingBehaviorEnumFactory

      class ActionGroupingBehaviorEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.ActionParticipantTypeEnumFactory

      class ActionParticipantTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.ActionPrecheckBehaviorEnumFactory

      class ActionPrecheckBehaviorEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.ActionRelationshipTypeEnumFactory

      class ActionRelationshipTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.ActionRequiredBehaviorEnumFactory

      class ActionRequiredBehaviorEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.ActionSelectionBehaviorEnumFactory

      class ActionSelectionBehaviorEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.AdministrativeGenderEnumFactory

      class AdministrativeGenderEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.AllLanguagesEnumFactory

      class AllLanguagesEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.BindingStrengthEnumFactory

      class BindingStrengthEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.CapabilityStatementKindEnumFactory

      class CapabilityStatementKindEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.ClaimProcessingCodesEnumFactory

      class ClaimProcessingCodesEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.CodeSystemContentModeEnumFactory

      class CodeSystemContentModeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.CommonLanguagesEnumFactory

      class CommonLanguagesEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.CompartmentTypeEnumFactory

      class CompartmentTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.CompositionStatusEnumFactory

      class CompositionStatusEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.ConceptMapRelationshipEnumFactory

      class ConceptMapRelationshipEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.ConsentDataMeaningEnumFactory

      class ConsentDataMeaningEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.ConsentProvisionTypeEnumFactory

      class ConsentProvisionTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.CurrenciesEnumFactory

      class CurrenciesEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.DaysOfWeekEnumFactory

      class DaysOfWeekEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.DeviceNameTypeEnumFactory

      class DeviceNameTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.EncounterStatusEnumFactory

      class EncounterStatusEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.EventStatusEnumFactory

      class EventStatusEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.EvidenceVariableHandlingEnumFactory

      class EvidenceVariableHandlingEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.ExampleScenarioActorTypeEnumFactory

      class ExampleScenarioActorTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.FHIRTypesEnumFactory

      class FHIRTypesEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.FHIRVersionEnumFactory

      class FHIRVersionEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.FilterOperatorEnumFactory

      class FilterOperatorEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.FinancialResourceStatusCodesEnumFactory

      class FinancialResourceStatusCodesEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.ListModeEnumFactory

      class ListModeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.MeasureImprovementNotationEnumFactory

      class MeasureImprovementNotationEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.MimeTypesEnumFactory

      class MimeTypesEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.ObservationStatusEnumFactory

      class ObservationStatusEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.OperationParameterUseEnumFactory

      class OperationParameterUseEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.PublicationStatusEnumFactory

      class PublicationStatusEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.QuantityComparatorEnumFactory

      class QuantityComparatorEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.RequestIntentEnumFactory

      class RequestIntentEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.RequestPriorityEnumFactory

      class RequestPriorityEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.RequestStatusEnumFactory

      class RequestStatusEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.ResourceTypeEnumEnumFactory

      class ResourceTypeEnumEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.SearchComparatorEnumFactory

      class SearchComparatorEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.SearchModifierCodeEnumFactory

      class SearchModifierCodeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.SearchParamTypeEnumFactory

      class SearchParamTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.SubscriptionStatusCodesEnumFactory

      class SubscriptionStatusCodesEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.UseEnumFactory

      class UseEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Enumerations.VersionIndependentResourceTypesAllEnumFactory

      class VersionIndependentResourceTypesAllEnumFactory extends Object implements Serializable

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

      class EpisodeOfCare extends DomainResource implements Serializable
      serialVersionUID:
      678200746L

      • Serialized Fields

        • account
          List<Reference> account
          The set of accounts that may be used for billing for this EpisodeOfCare.
        • careManager
          Reference careManager
          The practitioner that is the care manager/care coordinator for this patient.
        • careTeam
          List<Reference> careTeam
          The list of practitioners that may be facilitating this episode of care for specific purposes.
        • diagnosis
          List<EpisodeOfCare.DiagnosisComponent> diagnosis
          The list of medical conditions that were addressed during the episode of care.
        • identifier
          List<Identifier> identifier
          The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes.
        • managingOrganization
          Reference managingOrganization
          The organization that has assumed the specific responsibilities for care coordination, care delivery, or other services for the specified duration.
        • patient
          Reference patient
          The patient who is the focus of this episode of care.
        • period
          Period period
          The interval during which the managing organization assumes the defined responsibility.
        • reason
          List<EpisodeOfCare.ReasonComponent> reason
          The list of medical reasons that are expected to be addressed during the episode of care.
        • referralRequest
          List<Reference> referralRequest
          Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.
        • status
          Enumeration<EpisodeOfCare.EpisodeOfCareStatus> status
          planned | waitlist | active | onhold | finished | cancelled.
        • statusHistory
          List<EpisodeOfCare.EpisodeOfCareStatusHistoryComponent> statusHistory
          The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).
        • type
          List<CodeableConcept> type
          A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care.

    • Class org.hl7.fhir.r5.model.EpisodeOfCare.DiagnosisComponent

      class DiagnosisComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1997962887L

      • Serialized Fields

        • condition
          List<CodeableReference> condition
          The medical condition that was addressed during the episode of care, expressed as a text, code or a reference to another resource.
        • use
          CodeableConcept use
          Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge ?).

    • Class org.hl7.fhir.r5.model.EpisodeOfCare.EpisodeOfCareStatusEnumFactory

      class EpisodeOfCareStatusEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.EpisodeOfCare.EpisodeOfCareStatusHistoryComponent

      class EpisodeOfCareStatusHistoryComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1192432864L

    • Class org.hl7.fhir.r5.model.EpisodeOfCare.ReasonComponent

      class ReasonComponent extends BackboneElement implements Serializable
      serialVersionUID:
      322767075L

      • Serialized Fields

        • use
          CodeableConcept use
          What the reason value should be used as e.g. Chief Complaint, Health Concern, Health Maintenance (including screening).
        • value
          List<CodeableReference> value
          The medical reason that is expected to be addressed during the episode of care, expressed as a text, code or a reference to another resource.

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

      class EventDefinition extends MetadataResource implements Serializable
      serialVersionUID:
      -1047563679L

      • 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.
        • 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 event definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the event definition.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the event definition was last significantly changed. 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 event definition changes.
        • description
          MarkdownType description
          A free text natural language description of the event definition from a consumer's perspective.
        • editor
          List<ContactDetail> editor
          An individual or organization primarily responsible for internal coherence of the content.
        • effectivePeriod
          Period effectivePeriod
          The period during which the event definition content was or is planned to be in active use.
        • endorser
          List<ContactDetail> endorser
          An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this event 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 event 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 event 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.
        • name
          StringType name
          A natural language name identifying the event 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 responsible for the release and ongoing maintenance of the event definition.
        • purpose
          MarkdownType purpose
          Explanation of why this event definition is needed and why it has been designed as it has.
        • relatedArtifact
          List<RelatedArtifact> relatedArtifact
          Related resources such as additional documentation, justification, or bibliographic references.
        • reviewer
          List<ContactDetail> reviewer
          An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this event definition. Enables tracking the life-cycle of the content.
        • subject
          DataType subject
          A code or group definition that describes the intended subject of the event definition.
        • subtitle
          StringType subtitle
          An explanatory or alternate title for the event definition giving additional information about its content.
        • title
          StringType title
          A short, descriptive, user-friendly title for the event definition.
        • topic
          List<CodeableConcept> topic
          Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.
        • trigger
          List<TriggerDefinition> trigger
          The trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one of the trigger conditions is met.
        • url
          UriType url
          An absolute URI that is used to identify this event 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 an authoritative instance of this event definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the event definition is stored on different servers.
        • usage
          MarkdownType usage
          A detailed description of how the event 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 event definition instances.
        • version
          StringType version
          The identifier that is used to identify this version of the event definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the event 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

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

      class Evidence extends MetadataResource implements Serializable
      serialVersionUID:
      1427750968L

      • 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.
        • assertion
          MarkdownType assertion
          Declarative description of the Evidence.
        • author
          List<ContactDetail> author
          An individiual, organization, or device primarily involved in the creation and maintenance of the content.
        • certainty
          List<Evidence.EvidenceCertaintyComponent> certainty
          Assessment of certainty, confidence in the estimates, or quality of the evidence.
        • citeAs
          DataType citeAs
          Citation Resource or display of suggested citation for this evidence.
        • 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 Evidence and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the Evidence.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the summary was last significantly changed. 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 summary changes.
        • description
          MarkdownType description
          A free text natural language description of the evidence from a consumer's perspective.
        • editor
          List<ContactDetail> editor
          An individiual, organization, or device primarily responsible for internal coherence of the content.
        • endorser
          List<ContactDetail> endorser
          An individiual, organization, or device responsible for officially endorsing the content for use in some setting.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this resource 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 summary 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.
        • name
          StringType name
          A natural language name identifying the evidence. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • note
          List<Annotation> note
          Footnotes and/or explanatory notes.
        • publisher
          StringType publisher
          The name of the organization or individual responsible for the release and ongoing maintenance of the evidence.
        • purpose
          MarkdownType purpose
          Explanation of why this Evidence is needed and why it has been designed as it has.
        • relatedArtifact
          List<RelatedArtifact> relatedArtifact
          Link or citation to artifact associated with the summary.
        • reviewer
          List<ContactDetail> reviewer
          An individiual, organization, or device primarily responsible for review of some aspect of the content.
        • statistic
          List<Evidence.EvidenceStatisticComponent> statistic
          Values and parameters for a single statistic.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this summary. Enables tracking the life-cycle of the content.
        • studyDesign
          List<CodeableConcept> studyDesign
          The design of the study that produced this evidence. The design is described with any number of study design characteristics.
        • synthesisType
          CodeableConcept synthesisType
          The method to combine studies.
        • title
          StringType title
          A short, descriptive, user-friendly title for the summary.
        • url
          UriType url
          An absolute URI that is used to identify this evidence 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 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 evidence instances.
        • variableDefinition
          List<Evidence.EvidenceVariableDefinitionComponent> variableDefinition
          Evidence variable such as population, exposure, or outcome.
        • version
          StringType version
          The identifier that is used to identify this version of the summary when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the summary 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • Class org.hl7.fhir.r5.model.Evidence.EvidenceCertaintyComponent

      class EvidenceCertaintyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -139300414L

    • Class org.hl7.fhir.r5.model.Evidence.EvidenceStatisticAttributeEstimateComponent

      class EvidenceStatisticAttributeEstimateComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1535970380L

      • Serialized Fields

        • attributeEstimate
          List<Evidence.EvidenceStatisticAttributeEstimateComponent> attributeEstimate
          A nested attribute estimate; which is the attribute estimate of an attribute estimate.
        • description
          MarkdownType description
          Human-readable summary of the estimate.
        • level
          DecimalType level
          Use 95 for a 95% confidence interval.
        • note
          List<Annotation> note
          Footnote or explanatory note about the estimate.
        • quantity
          Quantity quantity
          The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure.
        • range
          Range range
          Lower bound of confidence interval.
        • type
          CodeableConcept type
          The type of attribute estimate, e.g., confidence interval or p value.

    • Class org.hl7.fhir.r5.model.Evidence.EvidenceStatisticComponent

      class EvidenceStatisticComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1798829622L

      • Serialized Fields

        • attributeEstimate
          List<Evidence.EvidenceStatisticAttributeEstimateComponent> attributeEstimate
          A statistical attribute of the statistic such as a measure of heterogeneity.
        • category
          CodeableConcept category
          When the measured variable is handled categorically, the category element is used to define which category the statistic is reporting.
        • description
          MarkdownType description
          A description of the content value of the statistic.
        • modelCharacteristic
          List<Evidence.EvidenceStatisticModelCharacteristicComponent> modelCharacteristic
          A component of the method to generate the statistic.
        • note
          List<Annotation> note
          Footnotes and/or explanatory notes.
        • numberAffected
          UnsignedIntType numberAffected
          The number of participants affected where the unit of analysis is the same as sampleSize.knownDataCount and sampleSize.numberOfParticipants.
        • numberOfEvents
          UnsignedIntType numberOfEvents
          The number of events associated with the statistic, where the unit of analysis is different from numberAffected, sampleSize.knownDataCount and sampleSize.numberOfParticipants.
        • quantity
          Quantity quantity
          Statistic value.
        • sampleSize
          Evidence.EvidenceStatisticSampleSizeComponent sampleSize
          Number of samples in the statistic.
        • statisticType
          CodeableConcept statisticType
          Type of statistic, e.g., relative risk.

    • Class org.hl7.fhir.r5.model.Evidence.EvidenceStatisticModelCharacteristicComponent

      class EvidenceStatisticModelCharacteristicComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1787793468L

    • Class org.hl7.fhir.r5.model.Evidence.EvidenceStatisticModelCharacteristicVariableComponent

      class EvidenceStatisticModelCharacteristicVariableComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1516174900L

      • Serialized Fields

        • handling
          Enumeration<Enumerations.EvidenceVariableHandling> handling
          How the variable is classified for use in adjusted analysis.
        • valueCategory
          List<CodeableConcept> valueCategory
          Description for grouping of ordinal or polychotomous variables.
        • valueQuantity
          List<Quantity> valueQuantity
          Discrete value for grouping of ordinal or polychotomous variables.
        • valueRange
          List<Range> valueRange
          Range of values for grouping of ordinal or polychotomous variables.
        • variableDefinition
          Reference variableDefinition
          Description of the variable.

    • Class org.hl7.fhir.r5.model.Evidence.EvidenceStatisticSampleSizeComponent

      class EvidenceStatisticSampleSizeComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1710653289L

      • Serialized Fields

        • description
          MarkdownType description
          Human-readable summary of population sample size.
        • knownDataCount
          UnsignedIntType knownDataCount
          Number of participants with known results for measured variables.
        • note
          List<Annotation> note
          Footnote or explanatory note about the sample size.
        • numberOfParticipants
          UnsignedIntType numberOfParticipants
          A human-readable string to clarify or explain concepts about the sample size.
        • numberOfStudies
          UnsignedIntType numberOfStudies
          Number of participants in the population.

    • Class org.hl7.fhir.r5.model.Evidence.EvidenceVariableDefinitionComponent

      class EvidenceVariableDefinitionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -702346164L

      • Serialized Fields

        • description
          MarkdownType description
          A text description or summary of the variable.
        • directnessMatch
          CodeableConcept directnessMatch
          Indication of quality of match between intended variable to actual variable.
        • intended
          Reference intended
          Definition of the intended variable related to the Evidence.
        • note
          List<Annotation> note
          Footnotes and/or explanatory notes.
        • observed
          Reference observed
          Definition of the actual variable related to the statistic(s).
        • variableRole
          CodeableConcept variableRole
          population | subpopulation | exposure | referenceExposure | measuredVariable | confounder.

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

      class EvidenceReport extends MetadataResource implements Serializable
      serialVersionUID:
      -1087028792L

      • Serialized Fields

        • author
          List<ContactDetail> author
          An individiual, organization, or device primarily involved in the creation and maintenance of the content.
        • citeAs
          DataType citeAs
          Citation Resource or display of suggested citation for this report.
        • contact
          List<ContactDetail> contact
          Contact details to assist a user in finding and communicating with the publisher.
        • editor
          List<ContactDetail> editor
          An individiual, organization, or device primarily responsible for internal coherence of the content.
        • endorser
          List<ContactDetail> endorser
          An individiual, organization, or device responsible for officially endorsing the content for use in some setting.
        • identifier
          List<Identifier> identifier
          A formal identifier that is used to identify this EvidenceReport when it is represented in other formats, or referenced in a specification, model, design or an instance.
        • note
          List<Annotation> note
          Used for footnotes and annotations.
        • publisher
          StringType publisher
          The name of the organization or individual responsible for the release and ongoing maintenance of the evidence report.
        • relatedArtifact
          List<RelatedArtifact> relatedArtifact
          Link, description or reference to artifact associated with the report.
        • relatedIdentifier
          List<Identifier> relatedIdentifier
          A formal identifier that is used to identify things closely related to this EvidenceReport.
        • relatesTo
          List<EvidenceReport.EvidenceReportRelatesToComponent> relatesTo
          Relationships that this composition has with other compositions or documents that already exist.
        • reviewer
          List<ContactDetail> reviewer
          An individiual, organization, or device primarily responsible for review of some aspect of the content.
        • section
          List<EvidenceReport.SectionComponent> section
          The root of the sections that make up the composition.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this summary. Enables tracking the life-cycle of the content.
        • subject
          EvidenceReport.EvidenceReportSubjectComponent subject
          Specifies the subject or focus of the report. Answers "What is this report about?".
        • type
          CodeableConcept type
          Specifies the kind of report, such as grouping of classifiers, search results, or human-compiled expression.
        • url
          UriType url
          An absolute URI that is used to identify this EvidenceReport 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 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 evidence report instances.

    • Class org.hl7.fhir.r5.model.EvidenceReport.EvidenceReportRelatesToComponent

      class EvidenceReportRelatesToComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1716908969L

    • Class org.hl7.fhir.r5.model.EvidenceReport.EvidenceReportRelatesToTargetComponent

      class EvidenceReportRelatesToTargetComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -804526425L

      • Serialized Fields

        • display
          MarkdownType display
          Target of the relationship Display.
        • identifier
          Identifier identifier
          Target of the relationship Identifier.
        • resource
          Reference resource
          Target of the relationship Resource reference.
        • url
          UriType url
          Target of the relationship URL.

    • Class org.hl7.fhir.r5.model.EvidenceReport.EvidenceReportSubjectCharacteristicComponent

      class EvidenceReportSubjectCharacteristicComponent extends BackboneElement implements Serializable
      serialVersionUID:
      279867823L

      • Serialized Fields

        • code
          CodeableConcept code
          Characteristic code.
        • exclude
          BooleanType exclude
          Is used to express not the characteristic.
        • period
          Period period
          Timeframe for the characteristic.
        • value
          DataType value
          Characteristic value.

    • Class org.hl7.fhir.r5.model.EvidenceReport.EvidenceReportSubjectComponent

      class EvidenceReportSubjectComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -734040873L

    • Class org.hl7.fhir.r5.model.EvidenceReport.ReportRelationshipTypeEnumFactory

      class ReportRelationshipTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.EvidenceReport.SectionComponent

      class SectionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -324854168L

      • Serialized Fields

        • author
          List<Reference> author
          Identifies who is responsible for the information in this section, not necessarily who typed it in.
        • emptyReason
          CodeableConcept emptyReason
          If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
        • entryClassifier
          List<CodeableConcept> entryClassifier
          Specifies any type of classification of the evidence report.
        • entryQuantity
          List<Quantity> entryQuantity
          Quantity as content.
        • entryReference
          List<Reference> entryReference
          A reference to the actual resource from which the narrative in the section is derived.
        • focus
          CodeableConcept focus
          A code identifying the kind of content contained within the section. This should be consistent with the section title.
        • focusReference
          Reference focusReference
          A definitional Resource identifying the kind of content contained within the section. This should be consistent with the section title.
        • 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<EvidenceReport.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 peferred to contain sufficient detail to make it acceptable 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.EvidenceVariable

      class EvidenceVariable extends MetadataResource implements Serializable
      serialVersionUID:
      -1626354085L

      • Serialized Fields

        • actual
          BooleanType actual
          True if the actual variable measured, false if a conceptual representation of the intended variable.
        • 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. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
        • author
          List<ContactDetail> author
          An individiual or organization primarily involved in the creation and maintenance of the content.
        • category
          List<EvidenceVariable.EvidenceVariableCategoryComponent> category
          A grouping for ordinal or polychotomous variables.
        • characteristic
          List<EvidenceVariable.EvidenceVariableCharacteristicComponent> characteristic
          A defining factor of the EvidenceVariable. Multiple characteristics are applied with "and" semantics.
        • 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 resource and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the resource.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the evidence variable was last significantly changed. 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 evidence variable changes.
        • description
          MarkdownType description
          A free text natural language description of the evidence variable from a consumer's perspective.
        • editor
          List<ContactDetail> editor
          An individual or organization primarily responsible for internal coherence of the content.
        • effectivePeriod
          Period effectivePeriod
          The period during which the resource content was or is planned to be in active use.
        • endorser
          List<ContactDetail> endorser
          An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this resource is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        • handling
          Enumeration<Enumerations.EvidenceVariableHandling> handling
          The method of handling in statistical analysis.
        • identifier
          List<Identifier> identifier
          A formal identifier that is used to identify this evidence variable when it is represented in other formats, or referenced in a specification, model, design or an instance.
        • lastReviewDate
          DateType lastReviewDate
          The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
        • name
          StringType name
          A natural language name identifying the evidence variable. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • note
          List<Annotation> note
          A human-readable string to clarify or explain concepts about the resource.
        • publisher
          StringType publisher
          The name of the organization or individual responsible for the release and ongoing maintenance of the evidence variable.
        • purpose
          MarkdownType purpose
          Explanation of why this EvidenceVariable is needed and why it has been designed as it has.
        • relatedArtifact
          List<RelatedArtifact> relatedArtifact
          Related artifacts such as additional documentation, justification, or bibliographic references.
        • reviewer
          List<ContactDetail> reviewer
          An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.
        • shortTitle
          StringType shortTitle
          The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this evidence variable. Enables tracking the life-cycle of the content.
        • title
          StringType title
          A short, descriptive, user-friendly title for the evidence variable.
        • url
          UriType url
          An absolute URI that is used to identify this evidence variable 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 an authoritative instance of this evidence variable is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the evidence variable 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 evidence variable instances.
        • version
          StringType version
          The identifier that is used to identify this version of the evidence variable when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the evidence variable 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 artifacts.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • Class org.hl7.fhir.r5.model.EvidenceVariable.CharacteristicCombinationEnumFactory

      class CharacteristicCombinationEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.EvidenceVariable.EvidenceVariableCategoryComponent

      class EvidenceVariableCategoryComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1839679495L

      • Serialized Fields

        • name
          StringType name
          Description of the grouping.
        • value
          DataType value
          Definition of the grouping.

    • Class org.hl7.fhir.r5.model.EvidenceVariable.EvidenceVariableCharacteristicComponent

      class EvidenceVariableCharacteristicComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1658283810L

      • Serialized Fields

        • definitionByCombination
          EvidenceVariable.EvidenceVariableCharacteristicDefinitionByCombinationComponent definitionByCombination
          Defines the characteristic as a combination of two or more characteristics.
        • definitionByTypeAndValue
          EvidenceVariable.EvidenceVariableCharacteristicDefinitionByTypeAndValueComponent definitionByTypeAndValue
          Defines the characteristic using both a type and value[x] elements.
        • definitionCanonical
          CanonicalType definitionCanonical
          Defines the characteristic using Canonical.
        • definitionCodeableConcept
          CodeableConcept definitionCodeableConcept
          Defines the characteristic using CodeableConcept.
        • definitionExpression
          Expression definitionExpression
          Defines the characteristic using Expression.
        • definitionId
          IdType definitionId
          Defines the characteristic using id.
        • definitionReference
          Reference definitionReference
          Defines the characteristic using a Reference.
        • description
          MarkdownType description
          A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user.
        • duration
          DataType duration
          Length of time in which the characteristic is met.
        • exclude
          BooleanType exclude
          When true, this characteristic is an exclusion criterion. In other words, not matching this characteristic definition is equivalent to meeting this criterion.
        • instances
          DataType instances
          Number of occurrences meeting the characteristic.
        • linkId
          IdType linkId
          Label used for when a characteristic refers to another characteristic.
        • note
          List<Annotation> note
          A human-readable string to clarify or explain concepts about the characteristic.
        • timeFromEvent
          List<EvidenceVariable.EvidenceVariableCharacteristicTimeFromEventComponent> timeFromEvent
          Timing in which the characteristic is determined.

    • Class org.hl7.fhir.r5.model.EvidenceVariable.EvidenceVariableCharacteristicDefinitionByCombinationComponent

      class EvidenceVariableCharacteristicDefinitionByCombinationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -2053118515L

    • Class org.hl7.fhir.r5.model.EvidenceVariable.EvidenceVariableCharacteristicDefinitionByTypeAndValueComponent

      class EvidenceVariableCharacteristicDefinitionByTypeAndValueComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -498341653L

      • Serialized Fields

        • device
          Reference device
          Device used for determining characteristic.
        • method
          List<CodeableConcept> method
          Method for how the characteristic value was determined.
        • offset
          CodeableConcept offset
          Defines the reference point for comparison when valueQuantity or valueRange is not compared to zero.
        • type
          CodeableConcept type
          Used to express the type of characteristic.
        • value
          DataType value
          Defines the characteristic when paired with characteristic.type.

    • Class org.hl7.fhir.r5.model.EvidenceVariable.EvidenceVariableCharacteristicTimeFromEventComponent

      class EvidenceVariableCharacteristicTimeFromEventComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1593501640L

      • Serialized Fields

        • description
          MarkdownType description
          Human readable description.
        • event
          DataType event
          The event used as a base point (reference point) in time.
        • note
          List<Annotation> note
          A human-readable string to clarify or explain concepts about the timeFromEvent.
        • quantity
          Quantity quantity
          Used to express the observation at a defined amount of time before or after the event.
        • range
          Range range
          Used to express the observation within a period before and/or after the event.

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

      class ExampleScenario extends CanonicalResource implements Serializable
      serialVersionUID:
      292494233L

      • Serialized Fields

        • actor
          List<ExampleScenario.ExampleScenarioActorComponent> actor
          A system or person who shares or receives an instance within the scenario.
        • 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 example scenario and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the example scenario.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the example scenario was last significantly changed. 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 example scenario changes. (e.g. the 'content logical definition').
        • description
          MarkdownType description
          A free text natural language description of the ExampleScenario from a consumer's perspective.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this example scenario 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 example scenario when it is represented in other formats, or referenced in a specification, model, design or an instance.
        • instance
          List<ExampleScenario.ExampleScenarioInstanceComponent> instance
          A single data collection that is shared as part of the scenario.
        • jurisdiction
          List<CodeableConcept> jurisdiction
          A legal or geographic region in which the example scenario is intended to be used.
        • name
          StringType name
          Temporarily retained for tooling purposes.
        • process
          List<ExampleScenario.ExampleScenarioProcessComponent> process
          A group of operations that represents a significant step within a scenario.
        • publisher
          StringType publisher
          The name of the organization or individual responsible for the release and ongoing maintenance of the example scenario.
        • purpose
          MarkdownType purpose
          What the example scenario resource is created for. This should not be used to show the business purpose of the scenario itself, but the purpose of documenting a scenario.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this example scenario. Enables tracking the life-cycle of the content.
        • title
          StringType title
          A short, descriptive, user-friendly title for the ExampleScenario.
        • url
          UriType url
          An absolute URI that is used to identify this example scenario 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 an authoritative instance of this example scenario is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the example scenario 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 example scenario instances.
        • version
          StringType version
          The identifier that is used to identify this version of the example scenario when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the example scenario 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • Class org.hl7.fhir.r5.model.ExampleScenario.ExampleScenarioActorComponent

      class ExampleScenarioActorComponent extends BackboneElement implements Serializable
      serialVersionUID:
      267911906L

      • Serialized Fields

    • Class org.hl7.fhir.r5.model.ExampleScenario.ExampleScenarioInstanceComponent

      class ExampleScenarioInstanceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1366610733L

      • Serialized Fields

        • containedInstance
          List<ExampleScenario.ExampleScenarioInstanceContainedInstanceComponent> containedInstance
          References to other instances that can be found within this instance (e.g. the observations contained in a bundle).
        • content
          Reference content
          Points to an instance (typically an example) that shows the data that would corespond to this instance.
        • description
          MarkdownType description
          An explanation of what the instance contains and what it's for.
        • key
          StringType key
          A unique string within the scenario that is used to reference the instance.
        • structureProfile
          DataType structureProfile
          Refers to a profile, template or other ruleset the instance adheres to.
        • structureType
          Coding structureType
          A code indicating the kind of data structure (FHIR resource or some other standard) this is an instance of.
        • structureVersion
          StringType structureVersion
          Conveys the version of the data structure instantiated. I.e. what release of FHIR, X12, OpenEHR, etc. is instance compliant with.
        • title
          StringType title
          A short descriptive label the instance to be used in tables or diagrams.
        • version
          List<ExampleScenario.ExampleScenarioInstanceVersionComponent> version
          Represents the instance as it was at a specific time-point.

    • Class org.hl7.fhir.r5.model.ExampleScenario.ExampleScenarioInstanceContainedInstanceComponent

      class ExampleScenarioInstanceContainedInstanceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      520704935L

      • Serialized Fields

        • instanceReference
          StringType instanceReference
          A reference to the key of an instance found within this one.
        • versionReference
          StringType versionReference
          A reference to the key of a specific version of an instance in this instance.

    • Class org.hl7.fhir.r5.model.ExampleScenario.ExampleScenarioInstanceVersionComponent

      class ExampleScenarioInstanceVersionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1218548928L

      • Serialized Fields

        • content
          Reference content
          Points to an instance (typically an example) that shows the data that would flow at this point in the scenario.
        • description
          MarkdownType description
          An explanation of what this specific version of the instance contains and represents.
        • key
          StringType key
          A unique string within the instance that is used to reference the version of the instance.
        • title
          StringType title
          A short descriptive label the version to be used in tables or diagrams.

    • Class org.hl7.fhir.r5.model.ExampleScenario.ExampleScenarioProcessComponent

      class ExampleScenarioProcessComponent extends BackboneElement implements Serializable
      serialVersionUID:
      325578043L

      • Serialized Fields

        • description
          MarkdownType description
          An explanation of what the process represents and what it does.
        • postConditions
          MarkdownType postConditions
          Description of the final state of the actors, environment and data after the process has been successfully completed.
        • preConditions
          MarkdownType preConditions
          Description of the initial state of the actors, environment and data before the process starts.
        • step
          List<ExampleScenario.ExampleScenarioProcessStepComponent> step
          A significant action that occurs as part of the process.
        • title
          StringType title
          A short descriptive label the process to be used in tables or diagrams.

    • Class org.hl7.fhir.r5.model.ExampleScenario.ExampleScenarioProcessStepAlternativeComponent

      class ExampleScenarioProcessStepAlternativeComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -254687460L

      • Serialized Fields

        • description
          MarkdownType description
          A human-readable description of the alternative explaining when the alternative should occur rather than the base step.
        • step
          List<ExampleScenario.ExampleScenarioProcessStepComponent> step
          Indicates the operation, sub-process or scenario that happens if the alternative option is selected.
        • title
          StringType title
          The label to display for the alternative that gives a sense of the circumstance in which the alternative should be invoked.

    • Class org.hl7.fhir.r5.model.ExampleScenario.ExampleScenarioProcessStepComponent

      class ExampleScenarioProcessStepComponent extends BackboneElement implements Serializable
      serialVersionUID:
      674607242L

    • Class org.hl7.fhir.r5.model.ExampleScenario.ExampleScenarioProcessStepOperationComponent

      class ExampleScenarioProcessStepOperationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -252586646L

      • Serialized Fields

        • description
          MarkdownType description
          An explanation of what the operation represents and what it does.
        • initiator
          StringType initiator
          The system that invokes the action/transmits the data.
        • initiatorActive
          BooleanType initiatorActive
          If false, the initiator is deactivated right after the operation.
        • receiver
          StringType receiver
          The system on which the action is invoked/receives the data.
        • receiverActive
          BooleanType receiverActive
          If false, the receiver is deactivated right after the operation.
        • request
          ExampleScenario.ExampleScenarioInstanceContainedInstanceComponent request
          A reference to the instance that is transmitted from requester to receiver as part of the invocation of the operation.
        • response
          ExampleScenario.ExampleScenarioInstanceContainedInstanceComponent response
          A reference to the instance that is transmitted from receiver to requester as part of the operation's synchronous response (if any).
        • title
          StringType title
          A short descriptive label the step to be used in tables or diagrams.
        • type
          Coding type
          The standardized type of action (FHIR or otherwise).

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

      class ExplanationOfBenefit extends DomainResource implements Serializable
      serialVersionUID:
      106661060L

      • Serialized Fields

        • accident
          ExplanationOfBenefit.AccidentComponent accident
          Details of a accident which resulted in injuries which required the products and services listed in the claim.
        • addItem
          List<ExplanationOfBenefit.AddedItemComponent> addItem
          The first-tier service adjudications for payor added product or service lines.
        • adjudication
          List<ExplanationOfBenefit.AdjudicationComponent> adjudication
          The adjudication results which are presented at the header level rather than at the line-item or add-item levels.
        • benefitBalance
          List<ExplanationOfBenefit.BenefitBalanceComponent> benefitBalance
          Balance by Benefit Category.
        • benefitPeriod
          Period benefitPeriod
          The term of the benefits documented in this response.
        • billablePeriod
          Period billablePeriod
          The period for which charges are being submitted.
        • careTeam
          List<ExplanationOfBenefit.CareTeamComponent> careTeam
          The members of the team who provided the products and services.
        • claim
          Reference claim
          The business identifier for the instance of the adjudication request: claim predetermination or preauthorization.
        • claimResponse
          Reference claimResponse
          The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response.
        • created
          DateTimeType created
          The date this resource was created.
        • decision
          CodeableConcept decision
          The result of the claim, predetermination, or preauthorization adjudication.
        • diagnosis
          List<ExplanationOfBenefit.DiagnosisComponent> diagnosis
          Information about diagnoses relevant to the claim items.
        • diagnosisRelatedGroup
          CodeableConcept diagnosisRelatedGroup
          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.
        • disposition
          StringType disposition
          A human readable description of the status of the adjudication.
        • encounter
          List<Reference> encounter
          Healthcare encounters related to this claim.
        • enterer
          Reference enterer
          Individual who created the claim, predetermination or preauthorization.
        • event
          List<ExplanationOfBenefit.ExplanationOfBenefitEventComponent> event
          Information code for an event with a corresponding date or period.
        • facility
          Reference facility
          Facility where the services were provided.
        • form
          Attachment form
          The actual form, by reference or inclusion, for printing the content or an EOB.
        • formCode
          CodeableConcept formCode
          A code for the form to be used for printing the content.
        • fundsReserve
          CodeableConcept fundsReserve
          A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.
        • fundsReserveRequested
          CodeableConcept fundsReserveRequested
          A code to indicate whether and for whom funds are to be reserved for future claims.
        • identifier
          List<Identifier> identifier
          A unique identifier assigned to this explanation of benefit.
        • insurance
          List<ExplanationOfBenefit.InsuranceComponent> insurance
          Financial instruments for reimbursement for the health care products and services specified on the claim.
        • insurer
          Reference insurer
          The party responsible for authorization, adjudication and reimbursement.
        • item
          List<ExplanationOfBenefit.ItemComponent> item
          A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.
        • originalPrescription
          Reference originalPrescription
          Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.
        • 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 forecast reimbursement is sought.
        • patientPaid
          Money patientPaid
          The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.
        • payee
          ExplanationOfBenefit.PayeeComponent payee
          The party to be reimbursed for cost of the products and services according to the terms of the policy.
        • payment
          ExplanationOfBenefit.PaymentComponent payment
          Payment details for the adjudication of the claim.
        • preAuthRef
          List<StringType> preAuthRef
          Reference from the Insurer which is used in later communications which refers to this adjudication.
        • preAuthRefPeriod
          List<Period> preAuthRefPeriod
          The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided.
        • precedence
          PositiveIntType precedence
          This indicates the relative order of a series of EOBs related to different coverages for the same suite of services.
        • prescription
          Reference prescription
          Prescription is the document/authorization given to the claim author for them to provide products and services for which consideration (reimbursement) is sought. Could be a RX for medications, an 'order' for oxygen or wheelchair or physiotherapy treatments.
        • priority
          CodeableConcept priority
          The provider-required urgency of processing the request. Typical values include: stat, normal deferred.
        • procedure
          List<ExplanationOfBenefit.ProcedureComponent> procedure
          Procedures performed on the patient relevant to the billing items with the claim.
        • processNote
          List<ExplanationOfBenefit.NoteComponent> processNote
          A note that describes or explains adjudication results in a human readable form.
        • provider
          Reference provider
          The provider which is responsible for the claim, predetermination or preauthorization.
        • referral
          Reference referral
          The referral information received by the claim author, it is not to be used when the author generates a referral for a patient. A copy of that referral may be provided as supporting information. Some insurers require proof of referral to pay for services or to pay specialist rates for services.
        • related
          List<ExplanationOfBenefit.RelatedClaimComponent> related
          Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.
        • status
          Enumeration<ExplanationOfBenefit.ExplanationOfBenefitStatus> status
          The status of the resource instance.
        • subType
          CodeableConcept subType
          A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.
        • supportingInfo
          List<ExplanationOfBenefit.SupportingInformationComponent> supportingInfo
          Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.
        • total
          List<ExplanationOfBenefit.TotalComponent> total
          Categorized monetary totals for the adjudication.
        • traceNumber
          List<Identifier> traceNumber
          Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.
        • 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: Claim - A request to an Insurer to adjudicate the supplied charges for health care goods and services under the identified policy and to pay the determined Benefit amount, if any; Preauthorization - A request to an Insurer to adjudicate the supplied proposed future charges for health care goods and services under the identified policy and to approve the services and provide the expected benefit amounts and potentially to reserve funds to pay the benefits when Claims for the indicated services are later submitted; or, Pre-determination - A request to an Insurer to adjudicate the supplied 'what if' charges for health care goods and services under the identified policy and report back what the Benefit payable would be had the services actually been provided.

    • Class org.hl7.fhir.r5.model.ExplanationOfBenefit.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.ExplanationOfBenefit.AddedItemBodySiteComponent

      class AddedItemBodySiteComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1190632415L

      • Serialized Fields

        • site
          List<CodeableReference> site
          Physical service site on the patient (limb, tooth, etc.).
        • subSite
          List<CodeableConcept> subSite
          A region or surface of the bodySite, e.g. limb region or tooth surface(s).

    • Class org.hl7.fhir.r5.model.ExplanationOfBenefit.AddedItemComponent

      class AddedItemComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1942324543L

      • Serialized Fields

        • adjudication
          List<ExplanationOfBenefit.AdjudicationComponent> adjudication
          The adjudication results.
        • bodySite
          List<ExplanationOfBenefit.AddedItemBodySiteComponent> bodySite
          Physical location where the service is performed or applies.
        • detail
          List<ExplanationOfBenefit.AddedItemDetailComponent> detail
          The second-tier service adjudications for payor added services.
        • detailSequence
          List<PositiveIntType> detailSequence
          The sequence number of the details within the claim item which this line is intended to replace.
        • factor
          DecimalType factor
          A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
        • itemSequence
          List<PositiveIntType> itemSequence
          Claim items which this service line is intended to replace.
        • location
          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 total amount claimed for the group (if a grouper) or the addItem. Net = unit price * quantity * factor.
        • noteNumber
          List<PositiveIntType> noteNumber
          The numbers associated with notes below which apply to the adjudication of this item.
        • patientPaid
          Money patientPaid
          The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.
        • productOrService
          CodeableConcept productOrService
          When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.
        • productOrServiceEnd
          CodeableConcept productOrServiceEnd
          This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.
        • 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.
        • request
          List<Reference> request
          Request or Referral for Goods or Service to be rendered.
        • revenue
          CodeableConcept revenue
          The type of revenue or cost center providing the product and/or service.
        • reviewOutcome
          ExplanationOfBenefit.ItemReviewOutcomeComponent reviewOutcome
          The high-level results of the adjudication if adjudication has been performed.
        • 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 woithin the details within the claim item which this line is intended to replace.
        • tax
          Money tax
          The total of taxes applicable for this product or service.
        • traceNumber
          List<Identifier> traceNumber
          Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.
        • 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.ExplanationOfBenefit.AddedItemDetailComponent

      class AddedItemDetailComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1088072336L

      • Serialized Fields

        • adjudication
          List<ExplanationOfBenefit.AdjudicationComponent> adjudication
          The adjudication results.
        • factor
          DecimalType factor
          A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
        • modifier
          List<CodeableConcept> modifier
          Item typification or modifiers codes to convey additional context for the product or service.
        • net
          Money net
          The total amount claimed for the group (if a grouper) or the addItem.detail. Net = unit price * quantity * factor.
        • noteNumber
          List<PositiveIntType> noteNumber
          The numbers associated with notes below which apply to the adjudication of this item.
        • patientPaid
          Money patientPaid
          The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.
        • productOrService
          CodeableConcept productOrService
          When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.
        • productOrServiceEnd
          CodeableConcept productOrServiceEnd
          This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.
        • 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.
        • reviewOutcome
          ExplanationOfBenefit.ItemReviewOutcomeComponent reviewOutcome
          The high-level results of the adjudication if adjudication has been performed.
        • subDetail
          List<ExplanationOfBenefit.AddedItemDetailSubDetailComponent> subDetail
          The third-tier service adjudications for payor added services.
        • tax
          Money tax
          The total of taxes applicable for this product or service.
        • traceNumber
          List<Identifier> traceNumber
          Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.
        • 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.ExplanationOfBenefit.AddedItemDetailSubDetailComponent

      class AddedItemDetailSubDetailComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -71243645L

      • Serialized Fields

        • adjudication
          List<ExplanationOfBenefit.AdjudicationComponent> adjudication
          The adjudication results.
        • factor
          DecimalType factor
          A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
        • modifier
          List<CodeableConcept> modifier
          Item typification or modifiers codes to convey additional context for the product or service.
        • net
          Money net
          The total amount claimed for the addItem.detail.subDetail. Net = unit price * quantity * factor.
        • noteNumber
          List<PositiveIntType> noteNumber
          The numbers associated with notes below which apply to the adjudication of this item.
        • patientPaid
          Money patientPaid
          The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.
        • productOrService
          CodeableConcept productOrService
          When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.
        • productOrServiceEnd
          CodeableConcept productOrServiceEnd
          This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.
        • 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.
        • reviewOutcome
          ExplanationOfBenefit.ItemReviewOutcomeComponent reviewOutcome
          The high-level results of the adjudication if adjudication has been performed.
        • tax
          Money tax
          The total of taxes applicable for this product or service.
        • traceNumber
          List<Identifier> traceNumber
          Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.
        • 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.ExplanationOfBenefit.AdjudicationComponent

      class AdjudicationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      29312734L

      • 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.
        • quantity
          Quantity quantity
          A non-monetary value associated with the category. Mutually exclusive to the amount element above.
        • reason
          CodeableConcept reason
          A code supporting the understanding of the adjudication result and explaining variance from expected amount.

    • Class org.hl7.fhir.r5.model.ExplanationOfBenefit.BenefitBalanceComponent

      class BenefitBalanceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1889655824L

      • Serialized Fields

        • category
          CodeableConcept category
          Code to identify the general type of benefits under which products and services are provided.
        • description
          StringType description
          A richer description of the benefit or services covered.
        • excluded
          BooleanType excluded
          True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.
        • financial
          List<ExplanationOfBenefit.BenefitComponent> financial
          Benefits Used to date.
        • name
          StringType name
          A short name or tag for the benefit.
        • network
          CodeableConcept network
          Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.
        • term
          CodeableConcept term
          The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.
        • unit
          CodeableConcept unit
          Indicates if the benefits apply to an individual or to the family.

    • Class org.hl7.fhir.r5.model.ExplanationOfBenefit.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.ExplanationOfBenefit.CareTeamComponent

      class CareTeamComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1238813503L

      • Serialized Fields

        • provider
          Reference provider
          Member of the team who provided the product or 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.
        • specialty
          CodeableConcept specialty
          The specialization of the practitioner or provider which is applicable for this service.

    • Class org.hl7.fhir.r5.model.ExplanationOfBenefit.DetailComponent

      class DetailComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1951425443L

      • Serialized Fields

        • adjudication
          List<ExplanationOfBenefit.AdjudicationComponent> adjudication
          The adjudication results.
        • category
          CodeableConcept category
          Code to identify the general type of benefits under which products and services are provided.
        • factor
          DecimalType factor
          A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
        • modifier
          List<CodeableConcept> modifier
          Item typification or modifiers codes to convey additional context for the product or service.
        • net
          Money net
          The total amount claimed for the group (if a grouper) or the line item.detail. Net = unit price * quantity * factor.
        • noteNumber
          List<PositiveIntType> noteNumber
          The numbers associated with notes below which apply to the adjudication of this item.
        • patientPaid
          Money patientPaid
          The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.
        • productOrService
          CodeableConcept productOrService
          When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.
        • productOrServiceEnd
          CodeableConcept productOrServiceEnd
          This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.
        • 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.
        • reviewOutcome
          ExplanationOfBenefit.ItemReviewOutcomeComponent reviewOutcome
          The high-level results of the adjudication if adjudication has been performed.
        • sequence
          PositiveIntType sequence
          A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.
        • subDetail
          List<ExplanationOfBenefit.SubDetailComponent> subDetail
          Third-tier of goods and services.
        • tax
          Money tax
          The total of taxes applicable for this product or service.
        • traceNumber
          List<Identifier> traceNumber
          Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.
        • 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.ExplanationOfBenefit.DiagnosisComponent

      class DiagnosisComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -320261526L

      • 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.
        • 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.ExplanationOfBenefit.ExplanationOfBenefitEventComponent

      class ExplanationOfBenefitEventComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -634897375L

      • Serialized Fields

        • type
          CodeableConcept type
          A coded event such as when a service is expected or a card printed.
        • when
          DataType when
          A date or period in the past or future indicating when the event occurred or is expectd to occur.

    • Class org.hl7.fhir.r5.model.ExplanationOfBenefit.ExplanationOfBenefitStatusEnumFactory

      class ExplanationOfBenefitStatusEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.ExplanationOfBenefit.InsuranceComponent

      class InsuranceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1519900285L

      • Serialized Fields

        • coverage
          Reference coverage
          Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system.
        • focal
          BooleanType focal
          A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.
        • preAuthRef
          List<StringType> preAuthRef
          Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization.

    • Class org.hl7.fhir.r5.model.ExplanationOfBenefit.ItemBodySiteComponent

      class ItemBodySiteComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1190632415L

      • Serialized Fields

        • site
          List<CodeableReference> site
          Physical service site on the patient (limb, tooth, etc.).
        • subSite
          List<CodeableConcept> subSite
          A region or surface of the bodySite, e.g. limb region or tooth surface(s).

    • Class org.hl7.fhir.r5.model.ExplanationOfBenefit.ItemComponent

      class ItemComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1905277239L

      • Serialized Fields

        • adjudication
          List<ExplanationOfBenefit.AdjudicationComponent> adjudication
          If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.
        • bodySite
          List<ExplanationOfBenefit.ItemBodySiteComponent> bodySite
          Physical location where the service is performed or applies.
        • careTeamSequence
          List<PositiveIntType> careTeamSequence
          Care team members related to this service or product.
        • category
          CodeableConcept category
          Code to identify the general type of benefits under which products and services are provided.
        • detail
          List<ExplanationOfBenefit.DetailComponent> detail
          Second-tier of goods and services.
        • diagnosisSequence
          List<PositiveIntType> diagnosisSequence
          Diagnoses applicable for this service or product.
        • encounter
          List<Reference> encounter
          Healthcare encounters related to this claim.
        • 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 total amount claimed for the group (if a grouper) or the line item. Net = unit price * quantity * factor.
        • noteNumber
          List<PositiveIntType> noteNumber
          The numbers associated with notes below which apply to the adjudication of this item.
        • patientPaid
          Money patientPaid
          The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.
        • 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 item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.
        • productOrServiceEnd
          CodeableConcept productOrServiceEnd
          This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.
        • 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.
        • request
          List<Reference> request
          Request or Referral for Goods or Service to be rendered.
        • revenue
          CodeableConcept revenue
          The type of revenue or cost center providing the product and/or service.
        • reviewOutcome
          ExplanationOfBenefit.ItemReviewOutcomeComponent reviewOutcome
          The high-level results of the adjudication if adjudication has been performed.
        • 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.
        • tax
          Money tax
          The total of taxes applicable for this product or service.
        • traceNumber
          List<Identifier> traceNumber
          Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.
        • 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.ExplanationOfBenefit.ItemReviewOutcomeComponent

      class ItemReviewOutcomeComponent extends BackboneElement implements Serializable
      serialVersionUID:
      2126097594L

      • Serialized Fields

        • decision
          CodeableConcept decision
          The result of the claim, predetermination, or preauthorization adjudication.
        • 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.
        • reason
          List<CodeableConcept> reason
          The reasons for the result of the claim, predetermination, or preauthorization adjudication.

    • Class org.hl7.fhir.r5.model.ExplanationOfBenefit.NoteComponent

      class NoteComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -944255449L

      • Serialized Fields

        • language
          CodeableConcept language
          A code to define the language used in the text of the note.
        • number
          PositiveIntType number
          A number to uniquely identify a note entry.
        • text
          StringType text
          The explanation or description associated with the processing.
        • type
          CodeableConcept type
          The business purpose of the note text.

    • Class org.hl7.fhir.r5.model.ExplanationOfBenefit.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.ExplanationOfBenefit.PaymentComponent

      class PaymentComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1539906026L

      • Serialized Fields

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

    • Class org.hl7.fhir.r5.model.ExplanationOfBenefit.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.ExplanationOfBenefit.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.ExplanationOfBenefit.SubDetailComponent

      class SubDetailComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -560048316L

      • Serialized Fields

        • adjudication
          List<ExplanationOfBenefit.AdjudicationComponent> adjudication
          The adjudication results.
        • category
          CodeableConcept category
          Code to identify the general type of benefits under which products and services are provided.
        • factor
          DecimalType factor
          A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
        • modifier
          List<CodeableConcept> modifier
          Item typification or modifiers codes to convey additional context for the product or service.
        • net
          Money net
          The total amount claimed for the line item.detail.subDetail. Net = unit price * quantity * factor.
        • noteNumber
          List<PositiveIntType> noteNumber
          The numbers associated with notes below which apply to the adjudication of this item.
        • patientPaid
          Money patientPaid
          The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.
        • productOrService
          CodeableConcept productOrService
          When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.
        • productOrServiceEnd
          CodeableConcept productOrServiceEnd
          This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.
        • 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.
        • reviewOutcome
          ExplanationOfBenefit.ItemReviewOutcomeComponent reviewOutcome
          The high-level results of the adjudication if adjudication has been performed.
        • sequence
          PositiveIntType sequence
          A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.
        • tax
          Money tax
          The total of taxes applicable for this product or service.
        • traceNumber
          List<Identifier> traceNumber
          Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.
        • 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.ExplanationOfBenefit.SupportingInformationComponent

      class SupportingInformationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1577205655L

      • Serialized Fields

        • category
          CodeableConcept category
          The general class of the information supplied: information; exception; accident, employment; onset, etc.
        • code
          CodeableConcept code
          System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.
        • reason
          Coding reason
          Provides the reason in the situation where a reason code is required in addition to the content.
        • sequence
          PositiveIntType sequence
          A number to uniquely identify supporting information entries.
        • timing
          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.ExplanationOfBenefit.TotalComponent

      class TotalComponent extends BackboneElement implements Serializable
      serialVersionUID:
      2012310309L

      • Serialized Fields

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

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

      class Expression extends DataType implements Serializable
      serialVersionUID:
      -1266682572L

      • Serialized Fields

        • description
          StringType description
          A brief, natural language description of the condition that effectively communicates the intended semantics.
        • expression
          StringType expression
          An expression in the specified language that returns a value.
        • language
          CodeType language
          The media type of the language for the expression.
        • name
          CodeType name
          A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.
        • reference
          UriType reference
          A URI that defines where the expression is found.

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

      class ExtendedContactDetail extends DataType implements Serializable
      serialVersionUID:
      154672475L

      • Serialized Fields

        • address
          Address address
          Address for the contact.
        • name
          List<HumanName> name
          The name of an individual to contact, some types of contact detail are usually blank.
        • organization
          Reference organization
          This contact detail is handled/monitored by a specific organization. If the name is provided in the contact, then it is referring to the named individual within this organization.
        • period
          Period period
          Period that this contact was valid for usage.
        • purpose
          CodeableConcept purpose
          The purpose/type of contact.
        • telecom
          List<ContactPoint> telecom
          The contact details application for the purpose defined.

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

      class Extension extends BaseExtension implements Serializable
      serialVersionUID:
      465890108L

      • Serialized Fields

        • url
          UriType url
          Source of the definition for the extension code - a logical name or a URL.
        • value
          DataType value
          Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).

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

      class FamilyMemberHistory extends DomainResource implements Serializable
      serialVersionUID:
      -1025621277L

      • Serialized Fields

        • age
          DataType age
          The age of the relative at the time the family member history is recorded.
        • born
          DataType born
          The actual or approximate date of birth of the relative.
        • condition
          List<FamilyMemberHistory.FamilyMemberHistoryConditionComponent> condition
          The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.
        • dataAbsentReason
          CodeableConcept dataAbsentReason
          Describes why the family member's history is not available.
        • date
          DateTimeType date
          The date (and possibly time) when the family member history was recorded or last updated.
        • deceased
          DataType deceased
          Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
        • estimatedAge
          BooleanType estimatedAge
          If true, indicates that the age value specified is an estimated value.
        • identifier
          List<Identifier> identifier
          Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
        • instantiatesCanonical
          List<CanonicalType> instantiatesCanonical
          The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.
        • instantiatesUri
          List<UriType> instantiatesUri
          The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.
        • name
          StringType name
          This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".
        • note
          List<Annotation> note
          This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.
        • participant
          List<FamilyMemberHistory.FamilyMemberHistoryParticipantComponent> participant
          Indicates who or what participated in the activities related to the family member history and how they were involved.
        • patient
          Reference patient
          The person who this history concerns.
        • procedure
          List<FamilyMemberHistory.FamilyMemberHistoryProcedureComponent> procedure
          The significant Procedures (or procedure) that the family member had. This is a repeating section to allow a system to represent more than one procedure per resource, though there is nothing stopping multiple resources - one per procedure.
        • reason
          List<CodeableReference> reason
          Describes why the family member history occurred in coded or textual form, or Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.
        • relationship
          CodeableConcept relationship
          The type of relationship this person has to the patient (father, mother, brother etc.).
        • sex
          CodeableConcept sex
          The birth sex of the family member.
        • status
          Enumeration<FamilyMemberHistory.FamilyHistoryStatus> status
          A code specifying the status of the record of the family history of a specific family member.

    • Class org.hl7.fhir.r5.model.FamilyMemberHistory.FamilyHistoryStatusEnumFactory

      class FamilyHistoryStatusEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.FamilyMemberHistory.FamilyMemberHistoryConditionComponent

      class FamilyMemberHistoryConditionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -91335661L

      • Serialized Fields

        • code
          CodeableConcept code
          The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system.
        • contributedToDeath
          BooleanType contributedToDeath
          This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.
        • note
          List<Annotation> note
          An area where general notes can be placed about this specific condition.
        • onset
          DataType onset
          Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.
        • outcome
          CodeableConcept outcome
          Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation.

    • Class org.hl7.fhir.r5.model.FamilyMemberHistory.FamilyMemberHistoryParticipantComponent

      class FamilyMemberHistoryParticipantComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -576943815L

      • Serialized Fields

        • actor
          Reference actor
          Indicates who or what participated in the activities related to the family member history.
        • function
          CodeableConcept function
          Distinguishes the type of involvement of the actor in the activities related to the family member history.

    • Class org.hl7.fhir.r5.model.FamilyMemberHistory.FamilyMemberHistoryProcedureComponent

      class FamilyMemberHistoryProcedureComponent extends BackboneElement implements Serializable
      serialVersionUID:
      281271062L

      • Serialized Fields

        • code
          CodeableConcept code
          The actual procedure specified. Could be a coded procedure or a less specific string depending on how much is known about the procedure and the capabilities of the creating system.
        • contributedToDeath
          BooleanType contributedToDeath
          This procedure contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.
        • note
          List<Annotation> note
          An area where general notes can be placed about this specific procedure.
        • outcome
          CodeableConcept outcome
          Indicates what happened following the procedure. If the procedure resulted in death, deceased date is captured on the relation.
        • performed
          DataType performed
          Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

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

      class Flag extends DomainResource implements Serializable
      serialVersionUID:
      -901823137L

      • Serialized Fields

        • author
          Reference author
          The person, organization or device that created the flag.
        • category
          List<CodeableConcept> category
          Allows a flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context.
        • code
          CodeableConcept code
          The coded value or textual component of the flag to display to the user.
        • encounter
          Reference encounter
          This alert is only relevant during the encounter.
        • identifier
          List<Identifier> identifier
          Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
        • period
          Period period
          The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified.
        • status
          Enumeration<Flag.FlagStatus> status
          Supports basic workflow.
        • subject
          Reference subject
          The patient, related person, location, group, organization, or practitioner etc. this is about record this flag is associated with.

    • Class org.hl7.fhir.r5.model.Flag.FlagStatusEnumFactory

      class FlagStatusEnumFactory extends Object implements Serializable

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

      class FormularyItem extends DomainResource implements Serializable
      serialVersionUID:
      601026823L

      • Serialized Fields

        • code
          CodeableConcept code
          A code (or set of codes) that specify the product or service that is identified by this formulary item.
        • identifier
          List<Identifier> identifier
          Business identifier for this formulary item.
        • status
          Enumeration<FormularyItem.FormularyItemStatusCodes> status
          The validity about the information of the formulary item and not of the underlying product or service itself.

    • Class org.hl7.fhir.r5.model.FormularyItem.FormularyItemStatusCodesEnumFactory

      class FormularyItemStatusCodesEnumFactory extends Object implements Serializable

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

      class GenomicStudy extends DomainResource implements Serializable
      serialVersionUID:
      644053021L

      • Serialized Fields

        • analysis
          List<GenomicStudy.GenomicStudyAnalysisComponent> analysis
          The details about a specific analysis that was performed in this GenomicStudy.
        • basedOn
          List<Reference> basedOn
          Event resources that the genomic study is based on.
        • description
          MarkdownType description
          Description of the genomic study.
        • encounter
          Reference encounter
          The healthcare event with which this genomics study is associated.
        • identifier
          List<Identifier> identifier
          Identifiers for this genomic study.
        • instantiatesCanonical
          CanonicalType instantiatesCanonical
          The defined protocol that describes the study.
        • instantiatesUri
          UriType instantiatesUri
          The URL pointing to an externally maintained protocol that describes the study.
        • interpreter
          List<Reference> interpreter
          Healthcare professionals who interpreted the genomic study.
        • note
          List<Annotation> note
          Comments related to the genomic study.
        • reason
          List<CodeableReference> reason
          Why the genomic study was performed.
        • referrer
          Reference referrer
          Healthcare professional who requested or referred the genomic study.
        • startDate
          DateTimeType startDate
          When the genomic study was started.
        • status
          Enumeration<GenomicStudy.GenomicStudyStatus> status
          The status of the genomic study.
        • subject
          Reference subject
          The primary subject of the genomic study.
        • type
          List<CodeableConcept> type
          The type of the study, e.g., Familial variant segregation, Functional variation detection, or Gene expression profiling.

    • Class org.hl7.fhir.r5.model.GenomicStudy.GenomicStudyAnalysisComponent

      class GenomicStudyAnalysisComponent extends BackboneElement implements Serializable
      serialVersionUID:
      467270310L

      • Serialized Fields

        • changeType
          List<CodeableConcept> changeType
          Type of the genomic changes studied in the analysis, e.g., DNA, RNA, or amino acid change.
        • date
          DateTimeType date
          The date of the analysis event.
        • device
          List<GenomicStudy.GenomicStudyAnalysisDeviceComponent> device
          Devices used for the analysis (e.g., instruments, software), with settings and parameters.
        • focus
          List<Reference> focus
          The focus of a genomic analysis when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, child, or sibling. For example, in trio testing, the GenomicStudy.subject would be the child (proband) and the GenomicStudy.analysis.focus of a specific analysis would be the parent.
        • genomeBuild
          CodeableConcept genomeBuild
          The reference genome build that is used in this analysis.
        • identifier
          List<Identifier> identifier
          Identifiers for the analysis event.
        • input
          List<GenomicStudy.GenomicStudyAnalysisInputComponent> input
          Inputs for the analysis event.
        • instantiatesCanonical
          CanonicalType instantiatesCanonical
          The defined protocol that describes the analysis.
        • instantiatesUri
          UriType instantiatesUri
          The URL pointing to an externally maintained protocol that describes the analysis.
        • methodType
          List<CodeableConcept> methodType
          Type of the methods used in the analysis, e.g., Fluorescence in situ hybridization (FISH), Karyotyping, or Microsatellite instability testing (MSI).
        • note
          List<Annotation> note
          Any notes capture with the analysis event.
        • output
          List<GenomicStudy.GenomicStudyAnalysisOutputComponent> output
          Outputs for the analysis event.
        • performer
          List<GenomicStudy.GenomicStudyAnalysisPerformerComponent> performer
          Performer for the analysis event.
        • protocolPerformed
          Reference protocolPerformed
          The protocol that was performed for the analysis event.
        • regionsCalled
          List<Reference> regionsCalled
          Genomic regions actually called in the analysis event (BED file).
        • regionsStudied
          List<Reference> regionsStudied
          The genomic regions to be studied in the analysis (BED file).
        • specimen
          List<Reference> specimen
          The specimen used in the analysis event.
        • title
          StringType title
          Name of the analysis event (human friendly).

    • Class org.hl7.fhir.r5.model.GenomicStudy.GenomicStudyAnalysisDeviceComponent

      class GenomicStudyAnalysisDeviceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1643933108L

      • Serialized Fields

        • device
          Reference device
          Device used for the analysis.
        • function
          CodeableConcept function
          Specific function for the device used for the analysis.

    • Class org.hl7.fhir.r5.model.GenomicStudy.GenomicStudyAnalysisInputComponent

      class GenomicStudyAnalysisInputComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -650883036L

      • Serialized Fields

        • file
          Reference file
          File containing input data.
        • generatedBy
          DataType generatedBy
          The analysis event or other GenomicStudy that generated this input file.
        • type
          CodeableConcept type
          Type of input data, e.g., BAM, CRAM, or FASTA.

    • Class org.hl7.fhir.r5.model.GenomicStudy.GenomicStudyAnalysisOutputComponent

      class GenomicStudyAnalysisOutputComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -2075265800L

      • Serialized Fields

        • file
          Reference file
          File containing output data.
        • type
          CodeableConcept type
          Type of output data, e.g., VCF, MAF, or BAM.

    • Class org.hl7.fhir.r5.model.GenomicStudy.GenomicStudyAnalysisPerformerComponent

      class GenomicStudyAnalysisPerformerComponent extends BackboneElement implements Serializable
      serialVersionUID:
      827444743L

      • Serialized Fields

        • actor
          Reference actor
          The organization, healthcare professional, or others who participated in performing this analysis.
        • role
          CodeableConcept role
          Role of the actor for this analysis.

    • Class org.hl7.fhir.r5.model.GenomicStudy.GenomicStudyStatusEnumFactory

      class GenomicStudyStatusEnumFactory extends Object implements Serializable

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

      class Goal extends DomainResource implements Serializable
      serialVersionUID:
      -884300976L

      • Serialized Fields

        • achievementStatus
          CodeableConcept achievementStatus
          Describes the progression, or lack thereof, towards the goal against the target.
        • addresses
          List<Reference> addresses
          The identified conditions and other health record elements that are intended to be addressed by the goal.
        • category
          List<CodeableConcept> category
          Indicates a category the goal falls within.
        • continuous
          BooleanType continuous
          After meeting the goal, ongoing activity is needed to sustain the goal objective.
        • description
          CodeableConcept description
          Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".
        • identifier
          List<Identifier> identifier
          Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
        • lifecycleStatus
          Enumeration<Goal.GoalLifecycleStatus> lifecycleStatus
          The state of the goal throughout its lifecycle.
        • note
          List<Annotation> note
          Any comments related to the goal.
        • outcome
          List<CodeableReference> outcome
          Identifies the change (or lack of change) at the point when the status of the goal is assessed.
        • priority
          CodeableConcept priority
          Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.
        • source
          Reference source
          Indicates whose goal this is - patient goal, practitioner goal, etc.
        • start
          DataType start
          The date or event after which the goal should begin being pursued.
        • statusDate
          DateType statusDate
          Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
        • statusReason
          StringType statusReason
          Captures the reason for the current status.
        • subject
          Reference subject
          Identifies the patient, group or organization for whom the goal is being established.
        • target
          List<Goal.GoalTargetComponent> target
          Indicates what should be done by when.

    • Class org.hl7.fhir.r5.model.Goal.GoalLifecycleStatusEnumFactory

      class GoalLifecycleStatusEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Goal.GoalTargetComponent

      class GoalTargetComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1975697830L

      • Serialized Fields

        • detail
          DataType detail
          The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.
        • due
          DataType due
          Indicates either the date or the duration after start by which the goal should be met.
        • measure
          CodeableConcept measure
          The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.

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

      class GraphDefinition extends CanonicalResource implements Serializable
      serialVersionUID:
      6161243L

      • 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 graph definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the graph definition.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the graph definition was last significantly changed. 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 graph definition changes.
        • description
          MarkdownType description
          A free text natural language description of the graph definition from a consumer's perspective.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this graph 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 GraphDefinition 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 graph definition is intended to be used.
        • link
          List<GraphDefinition.GraphDefinitionLinkComponent> link
          Links this graph makes rules about.
        • name
          StringType name
          A natural language name identifying the graph definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • node
          List<GraphDefinition.GraphDefinitionNodeComponent> node
          Potential target for the link.
        • publisher
          StringType publisher
          The name of the organization or individual responsible for the release and ongoing maintenance of the graph definition.
        • purpose
          MarkdownType purpose
          Explanation of why this graph definition is needed and why it has been designed as it has.
        • start
          IdType start
          The Node at which instances of this graph start. If there is no nominated start, the graph can start at any of the nodes.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this graph definition. 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 graph 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 an authoritative instance of this graph definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the graph 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 graph definition instances.
        • version
          StringType version
          The identifier that is used to identify this version of the graph definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the graph 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • Class org.hl7.fhir.r5.model.GraphDefinition.GraphCompartmentRuleEnumFactory

      class GraphCompartmentRuleEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.GraphDefinition.GraphCompartmentUseEnumFactory

      class GraphCompartmentUseEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.GraphDefinition.GraphDefinitionLinkCompartmentComponent

      class GraphDefinitionLinkCompartmentComponent extends BackboneElement implements Serializable
      serialVersionUID:
      2140045786L

    • Class org.hl7.fhir.r5.model.GraphDefinition.GraphDefinitionLinkComponent

      class GraphDefinitionLinkComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -433118895L

      • Serialized Fields

        • compartment
          List<GraphDefinition.GraphDefinitionLinkCompartmentComponent> compartment
          Compartment Consistency Rules.
        • description
          StringType description
          Information about why this link is of interest in this graph definition.
        • max
          StringType max
          Maximum occurrences for this link.
        • min
          IntegerType min
          Minimum occurrences for this link.
        • params
          StringType params
          A set of parameters to look up.
        • path
          StringType path
          A FHIRPath expression that identifies one of FHIR References to other resources.
        • sliceName
          StringType sliceName
          Which slice (if profiled).
        • sourceId
          IdType sourceId
          The source node for this link.
        • targetId
          IdType targetId
          The target node for this link.

    • Class org.hl7.fhir.r5.model.GraphDefinition.GraphDefinitionNodeComponent

      class GraphDefinitionNodeComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1497429325L

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

      class Group extends DomainResource implements Serializable
      serialVersionUID:
      -39542514L

      • Serialized Fields

        • active
          BooleanType active
          Indicates whether the record for the group is available for use or is merely being retained for historical purposes.
        • characteristic
          List<Group.GroupCharacteristicComponent> characteristic
          Identifies traits whose presence r absence is shared by members of the group.
        • code
          CodeableConcept code
          Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc.
        • description
          MarkdownType description
          Explanation of what the group represents and how it is intended to be used.
        • identifier
          List<Identifier> identifier
          Business identifiers assigned to this participant by one of the applications involved. These identifiers remain constant as the resource is updated and propagates from server to server.
        • managingEntity
          Reference managingEntity
          Entity responsible for defining and maintaining Group characteristics and/or registered members.
        • member
          List<Group.GroupMemberComponent> member
          Identifies the resource instances that are members of the group.
        • membership
          Enumeration<Group.GroupMembershipBasis> membership
          Basis for membership in the Group: 'definitional': The Group.characteristics specified are both necessary and sufficient to determine membership. All entities that meet the criteria are considered to be members of the group, whether referenced by the group or not. If members are present, they are individuals that happen to be known as meeting the Group.characteristics. The list cannot be presumed to be complete. 'enumerated': The Group.characteristics are necessary but not sufficient to determine membership. Membership is determined by being listed as one of the Group.member.
        • name
          StringType name
          A label assigned to the group for human identification and communication.
        • quantity
          UnsignedIntType quantity
          A count of the number of resource instances that are part of the group.
        • type
          Enumeration<Group.GroupType> type
          Identifies the broad classification of the kind of resources the group includes.

    • Class org.hl7.fhir.r5.model.Group.GroupCharacteristicComponent

      class GroupCharacteristicComponent extends BackboneElement implements Serializable
      serialVersionUID:
      279867823L

      • Serialized Fields

        • code
          CodeableConcept code
          A code that identifies the kind of trait being asserted.
        • exclude
          BooleanType exclude
          If true, indicates the characteristic is one that is NOT held by members of the group.
        • period
          Period period
          The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.
        • value
          DataType value
          The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

    • Class org.hl7.fhir.r5.model.Group.GroupMemberComponent

      class GroupMemberComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1206153083L

      • Serialized Fields

        • entity
          Reference entity
          A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same.
        • inactive
          BooleanType inactive
          A flag to indicate that the member is no longer in the group, but previously may have been a member.
        • period
          Period period
          The period that the member was in the group, if known.

    • Class org.hl7.fhir.r5.model.Group.GroupMembershipBasisEnumFactory

      class GroupMembershipBasisEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Group.GroupTypeEnumFactory

      class GroupTypeEnumFactory extends Object implements Serializable

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

      class GuidanceResponse extends DomainResource implements Serializable
      serialVersionUID:
      1439061923L

      • Serialized Fields

        • dataRequirement
          List<DataRequirement> dataRequirement
          If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.
        • encounter
          Reference encounter
          The encounter during which this response was created or to which the creation of this record is tightly associated.
        • evaluationMessage
          Reference evaluationMessage
          Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.
        • identifier
          List<Identifier> identifier
          Allows a service to provide unique, business identifiers for the response.
        • module
          DataType module
          An identifier, CodeableConcept or canonical reference to the guidance that was requested.
        • note
          List<Annotation> note
          Provides a mechanism to communicate additional information about the response.
        • occurrenceDateTime
          DateTimeType occurrenceDateTime
          Indicates when the guidance response was processed.
        • outputParameters
          Reference outputParameters
          The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element.
        • performer
          Reference performer
          Provides a reference to the device that performed the guidance.
        • reason
          List<CodeableReference> reason
          Describes the reason for the guidance response in coded or textual form, or Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.
        • requestIdentifier
          Identifier requestIdentifier
          The identifier of the request associated with this response. If an identifier was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario.
        • result
          List<Reference> result
          The actions, if any, produced by the evaluation of the artifact.
        • status
          Enumeration<GuidanceResponse.GuidanceResponseStatus> status
          The status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information.
        • subject
          Reference subject
          The patient for which the request was processed.

    • Class org.hl7.fhir.r5.model.GuidanceResponse.GuidanceResponseStatusEnumFactory

      class GuidanceResponseStatusEnumFactory extends Object implements Serializable

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

      class HealthcareService extends DomainResource implements Serializable
      serialVersionUID:
      -438716159L

      • Serialized Fields

        • active
          BooleanType active
          This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.
        • appointmentRequired
          BooleanType appointmentRequired
          Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.
        • availability
          List<Availability> availability
          A collection of times that the healthcare service is available.
        • category
          List<CodeableConcept> category
          Identifies the broad category of service being performed or delivered.
        • characteristic
          List<CodeableConcept> characteristic
          Collection of characteristics (attributes).
        • comment
          MarkdownType comment
          Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.
        • communication
          List<CodeableConcept> communication
          Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used.
        • contact
          List<ExtendedContactDetail> contact
          The contact details of communication devices available relevant to the specific HealthcareService. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.
        • coverageArea
          List<Reference> coverageArea
          The location(s) that this service is available to (not where the service is provided).
        • eligibility
          List<HealthcareService.HealthcareServiceEligibilityComponent> eligibility
          Does this service have specific eligibility requirements that need to be met in order to use the service?
        • endpoint
          List<Reference> endpoint
          Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.
        • extraDetails
          MarkdownType extraDetails
          Extra details about the service that can't be placed in the other fields.
        • identifier
          List<Identifier> identifier
          External identifiers for this item.
        • location
          List<Reference> location
          The location(s) where this healthcare service may be provided.
        • name
          StringType name
          Further description of the service as it would be presented to a consumer while searching.
        • offeredIn
          List<Reference> offeredIn
          When the HealthcareService is representing a specific, schedulable service, the availableIn property can refer to a generic service.
        • photo
          Attachment photo
          If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.
        • program
          List<CodeableConcept> program
          Programs that this service is applicable to.
        • providedBy
          Reference providedBy
          The organization that provides this healthcare service.
        • referralMethod
          List<CodeableConcept> referralMethod
          Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.
        • serviceProvisionCode
          List<CodeableConcept> serviceProvisionCode
          The code(s) that detail the conditions under which the healthcare service is available/offered.
        • specialty
          List<CodeableConcept> specialty
          Collection of specialties handled by the Healthcare service. This is more of a medical term.
        • type
          List<CodeableConcept> type
          The specific type of service that may be delivered or performed.

    • Class org.hl7.fhir.r5.model.HealthcareService.HealthcareServiceEligibilityComponent

      class HealthcareServiceEligibilityComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1078065348L

      • Serialized Fields

        • code
          CodeableConcept code
          Coded value for the eligibility.
        • comment
          MarkdownType comment
          Describes the eligibility conditions for the service.

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

      class HumanName extends DataType implements Serializable
      serialVersionUID:
      -507469160L

      • Serialized Fields

        • family
          StringType family
          The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
        • given
          List<StringType> given
          Given name.
        • period
          Period period
          Indicates the period of time when this name was valid for the named person.
        • prefix
          List<StringType> prefix
          Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
        • suffix
          List<StringType> suffix
          Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
        • text
          StringType text
          Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.
        • use
          Enumeration<HumanName.NameUse> use
          Identifies the purpose for this name.

    • Class org.hl7.fhir.r5.model.HumanName.NameUseEnumFactory

      class NameUseEnumFactory extends Object implements Serializable

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

      class Identifier extends DataType implements Serializable
      serialVersionUID:
      2098433371L

      • Serialized Fields

        • assigner
          Reference assigner
          Organization that issued/manages the identifier.
        • period
          Period period
          Time period during which identifier is/was valid for use.
        • system
          UriType system
          Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
        • type
          CodeableConcept type
          A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
        • use
          Enumeration<Identifier.IdentifierUse> use
          The purpose of this identifier.
        • value
          StringType value
          The portion of the identifier typically relevant to the user and which is unique within the context of the system.

    • Class org.hl7.fhir.r5.model.Identifier.IdentifierUseEnumFactory

      class IdentifierUseEnumFactory extends Object implements Serializable

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

      class IdType extends UriType implements Externalizable
      serialVersionUID:
      2L

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

      class ImagingSelection extends DomainResource implements Serializable
      serialVersionUID:
      -1733487270L

      • Serialized Fields

        • basedOn
          List<Reference> basedOn
          A list of the diagnostic requests that resulted in this imaging selection being performed.
        • bodySite
          CodeableReference bodySite
          The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings.
        • category
          List<CodeableConcept> category
          Classifies the imaging selection.
        • code
          CodeableConcept code
          Reason for referencing the selected content.
        • derivedFrom
          List<Reference> derivedFrom
          The imaging study from which the imaging selection is made.
        • endpoint
          List<Reference> endpoint
          The network service providing retrieval access to the selected images, frames, etc. See implementation notes for information about using DICOM endpoints.
        • focus
          List<Reference> focus
          The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
        • frameOfReferenceUid
          IdType frameOfReferenceUid
          The Frame of Reference UID identifying the coordinate system that conveys spatial and/or temporal information for the selected images or frames.
        • identifier
          List<Identifier> identifier
          A unique identifier assigned to this imaging selection.
        • instance
          List<ImagingSelection.ImagingSelectionInstanceComponent> instance
          Each imaging selection includes one or more selected DICOM SOP instances.
        • issued
          InstantType issued
          The date and time this imaging selection was created.
        • performer
          List<ImagingSelection.ImagingSelectionPerformerComponent> performer
          Selector of the instances ? human or machine.
        • seriesNumber
          UnsignedIntType seriesNumber
          The Series Number for the DICOM Series from which the images were selected.
        • seriesUid
          IdType seriesUid
          The Series Instance UID for the DICOM Series from which the images were selected.
        • status
          Enumeration<ImagingSelection.ImagingSelectionStatus> status
          The current state of the ImagingSelection resource. This is not the status of any ImagingStudy, ServiceRequest, or Task resources associated with the ImagingSelection.
        • studyUid
          IdType studyUid
          The Study Instance UID for the DICOM Study from which the images were selected.
        • subject
          Reference subject
          The patient, or group of patients, location, device, organization, procedure or practitioner this imaging selection is about and into whose or what record the imaging selection is placed.

    • Class org.hl7.fhir.r5.model.ImagingSelection.ImageRegion2DComponent

      class ImageRegion2DComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1518695052L

      • Serialized Fields

        • coordinate
          List<DecimalType> coordinate
          The coordinates describing the image region. Encoded as a set of (column, row) pairs that denote positions in the selected image / frames specified with sub-pixel resolution. The origin at the TLHC of the TLHC pixel is 0.0\0.0, the BRHC of the TLHC pixel is 1.0\1.0, and the BRHC of the BRHC pixel is the number of columns\rows in the image / frames. The values must be within the range 0\0 to the number of columns\rows in the image / frames.
        • regionType
          Enumeration<ImagingSelection.ImagingSelection2DGraphicType> regionType
          Specifies the type of image region.

    • Class org.hl7.fhir.r5.model.ImagingSelection.ImageRegion3DComponent

      class ImageRegion3DComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1532227853L

      • Serialized Fields

        • coordinate
          List<DecimalType> coordinate
          The coordinates describing the image region. Encoded as an ordered set of (x,y,z) triplets (in mm and may be negative) that define a region of interest in the patient-relative Reference Coordinate System defined by ImagingSelection.frameOfReferenceUid element.
        • regionType
          Enumeration<ImagingSelection.ImagingSelection3DGraphicType> regionType
          Specifies the type of image region.

    • Class org.hl7.fhir.r5.model.ImagingSelection.ImagingSelection2DGraphicTypeEnumFactory

      class ImagingSelection2DGraphicTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.ImagingSelection.ImagingSelection3DGraphicTypeEnumFactory

      class ImagingSelection3DGraphicTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.ImagingSelection.ImagingSelectionInstanceComponent

      class ImagingSelectionInstanceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1783712351L

      • Serialized Fields

        • imageRegion2D
          List<ImagingSelection.ImageRegion2DComponent> imageRegion2D
          Each imaging selection instance or frame list might includes an image region, specified by a region type and a set of 2D coordinates. If the parent imagingSelection.instance contains a subset element of type frame, the image region applies to all frames in the subset list.
        • imageRegion3D
          List<ImagingSelection.ImageRegion3DComponent> imageRegion3D
          Each imaging selection might includes a 3D image region, specified by a region type and a set of 3D coordinates.
        • number
          UnsignedIntType number
          The Instance Number for the selected DICOM instance.
        • sopClass
          Coding sopClass
          The SOP Class UID for the selected DICOM instance.
        • subset
          List<StringType> subset
          Selected subset of the SOP Instance. The content and format of the subset item is determined by the SOP Class of the selected instance. May be one of: - A list of frame numbers selected from a multiframe SOP Instance. - A list of Content Item Observation UID values selected from a DICOM SR or other structured document SOP Instance. - A list of segment numbers selected from a segmentation SOP Instance. - A list of Region of Interest (ROI) numbers selected from a radiotherapy structure set SOP Instance.
        • uid
          IdType uid
          The SOP Instance UID for the selected DICOM instance.

    • Class org.hl7.fhir.r5.model.ImagingSelection.ImagingSelectionPerformerComponent

      class ImagingSelectionPerformerComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -576943815L

      • Serialized Fields

        • actor
          Reference actor
          Author ? human or machine.
        • function
          CodeableConcept function
          Distinguishes the type of involvement of the performer.

    • Class org.hl7.fhir.r5.model.ImagingSelection.ImagingSelectionStatusEnumFactory

      class ImagingSelectionStatusEnumFactory extends Object implements Serializable

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

      class ImagingStudy extends DomainResource implements Serializable
      serialVersionUID:
      -1519153867L

      • Serialized Fields

        • basedOn
          List<Reference> basedOn
          A list of the diagnostic requests that resulted in this imaging study being performed.
        • description
          StringType description
          The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.
        • encounter
          Reference encounter
          The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made.
        • endpoint
          List<Reference> endpoint
          The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.
        • identifier
          List<Identifier> identifier
          Identifiers for the ImagingStudy such as DICOM Study Instance UID.
        • location
          Reference location
          The principal physical location where the ImagingStudy was performed.
        • modality
          List<CodeableConcept> modality
          A list of all the distinct values of series.modality. This may include both acquisition and non-acquisition modalities.
        • note
          List<Annotation> note
          Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.
        • numberOfInstances
          UnsignedIntType numberOfInstances
          Number of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.
        • numberOfSeries
          UnsignedIntType numberOfSeries
          Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.
        • partOf
          List<Reference> partOf
          A larger event of which this particular ImagingStudy is a component or step. For example, an ImagingStudy as part of a procedure.
        • procedure
          List<CodeableReference> procedure
          This field corresponds to the DICOM Procedure Code Sequence (0008,1032). This is different from the FHIR Procedure resource that may include the ImagingStudy.
        • reason
          List<CodeableReference> reason
          Description of clinical condition indicating why the ImagingStudy was requested, and/or Indicates another resource whose existence justifies this Study.
        • referrer
          Reference referrer
          The requesting/referring physician.
        • series
          List<ImagingStudy.ImagingStudySeriesComponent> series
          Each study has one or more series of images or other content.
        • started
          DateTimeType started
          Date and time the study started.
        • status
          Enumeration<ImagingStudy.ImagingStudyStatus> status
          The current state of the ImagingStudy resource. This is not the status of any ServiceRequest or Task resources associated with the ImagingStudy.
        • subject
          Reference subject
          The subject, typically a patient, of the imaging study.

    • Class org.hl7.fhir.r5.model.ImagingStudy.ImagingStudySeriesComponent

      class ImagingStudySeriesComponent extends BackboneElement implements Serializable
      serialVersionUID:
      755136591L

      • Serialized Fields

        • bodySite
          CodeableReference bodySite
          The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality.
        • description
          StringType description
          A description of the series.
        • endpoint
          List<Reference> endpoint
          The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.connectionType.
        • instance
          List<ImagingStudy.ImagingStudySeriesInstanceComponent> instance
          A single SOP instance within the series, e.g. an image, or presentation state.
        • laterality
          CodeableConcept laterality
          The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite.
        • modality
          CodeableConcept modality
          The distinct modality for this series. This may include both acquisition and non-acquisition modalities.
        • number
          UnsignedIntType number
          The numeric identifier of this series in the study.
        • numberOfInstances
          UnsignedIntType numberOfInstances
          Number of SOP Instances in the Study. The value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.
        • performer
          List<ImagingStudy.ImagingStudySeriesPerformerComponent> performer
          Indicates who or what performed the series and how they were involved.
        • specimen
          List<Reference> specimen
          The specimen imaged, e.g., for whole slide imaging of a biopsy.
        • started
          DateTimeType started
          The date and time the series was started.
        • uid
          IdType uid
          The DICOM Series Instance UID for the series.

    • Class org.hl7.fhir.r5.model.ImagingStudy.ImagingStudySeriesInstanceComponent

      class ImagingStudySeriesInstanceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -888152445L

      • Serialized Fields

        • number
          UnsignedIntType number
          The number of instance in the series.
        • sopClass
          Coding sopClass
          DICOM instance type.
        • title
          StringType title
          The description of the instance.
        • uid
          IdType uid
          The DICOM SOP Instance UID for this image or other DICOM content.

    • Class org.hl7.fhir.r5.model.ImagingStudy.ImagingStudySeriesPerformerComponent

      class ImagingStudySeriesPerformerComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -576943815L

      • Serialized Fields

        • actor
          Reference actor
          Indicates who or what performed the series.
        • function
          CodeableConcept function
          Distinguishes the type of involvement of the performer in the series.

    • Class org.hl7.fhir.r5.model.ImagingStudy.ImagingStudyStatusEnumFactory

      class ImagingStudyStatusEnumFactory extends Object implements Serializable

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

      class Immunization extends DomainResource implements Serializable
      serialVersionUID:
      425193818L

      • Serialized Fields

        • administeredProduct
          CodeableReference administeredProduct
          An indication of which product was administered to the patient. This is typically a more detailed representation of the concept conveyed by the vaccineCode data element. If a Medication resource is referenced, it may be to a stand-alone resource or a contained resource within the Immunization resource.
        • basedOn
          List<Reference> basedOn
          A plan, order or recommendation fulfilled in whole or in part by this immunization.
        • doseQuantity
          Quantity doseQuantity
          The quantity of vaccine product that was administered.
        • encounter
          Reference encounter
          The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
        • expirationDate
          DateType expirationDate
          Date vaccine batch expires.
        • fundingSource
          CodeableConcept fundingSource
          Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).
        • identifier
          List<Identifier> identifier
          A unique identifier assigned to this immunization record.
        • informationSource
          CodeableReference informationSource
          Typically the source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
        • isSubpotent
          BooleanType isSubpotent
          Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
        • location
          Reference location
          The service delivery location where the vaccine administration occurred.
        • lotNumber
          StringType lotNumber
          Lot number of the vaccine product.
        • manufacturer
          CodeableReference manufacturer
          Name of vaccine manufacturer.
        • note
          List<Annotation> note
          Extra information about the immunization that is not conveyed by the other attributes.
        • occurrence
          DataType occurrence
          Date vaccine administered or was to be administered.
        • patient
          Reference patient
          The patient who either received or did not receive the immunization.
        • performer
          List<Immunization.ImmunizationPerformerComponent> performer
          Indicates who performed the immunization event.
        • primarySource
          BooleanType primarySource
          Indicates whether the data contained in the resource was captured by the individual/organization which was responsible for the administration of the vaccine rather than as 'secondary reported' data documented by a third party. A value of 'true' means this data originated with the individual/organization which was responsible for the administration of the vaccine.
        • programEligibility
          List<Immunization.ImmunizationProgramEligibilityComponent> programEligibility
          Indicates a patient's eligibility for a funding program.
        • protocolApplied
          List<Immunization.ImmunizationProtocolAppliedComponent> protocolApplied
          The protocol (set of recommendations) being followed by the provider who administered the dose.
        • reaction
          List<Immunization.ImmunizationReactionComponent> reaction
          Categorical data indicating that an adverse event is associated in time to an immunization.
        • reason
          List<CodeableReference> reason
          Describes why the immunization occurred in coded or textual form, or Indicates another resource (Condition, Observation or DiagnosticReport) whose existence justifies this immunization.
        • route
          CodeableConcept route
          The path by which the vaccine product is taken into the body.
        • site
          CodeableConcept site
          Body site where vaccine was administered.
        • status
          Enumeration<Immunization.ImmunizationStatusCodes> status
          Indicates the current status of the immunization event.
        • statusReason
          CodeableConcept statusReason
          Indicates the reason the immunization event was not performed.
        • subpotentReason
          List<CodeableConcept> subpotentReason
          Reason why a dose is considered to be subpotent.
        • supportingInformation
          List<Reference> supportingInformation
          Additional information that is relevant to the immunization (e.g. for a vaccine recipient who is pregnant, the gestational age of the fetus). The reason why a vaccine was given (e.g. occupation, underlying medical condition) should be conveyed in Immunization.reason, not as supporting information. The reason why a vaccine was not given (e.g. contraindication) should be conveyed in Immunization.statusReason, not as supporting information.
        • vaccineCode
          CodeableConcept vaccineCode
          Vaccine that was administered or was to be administered.

    • Class org.hl7.fhir.r5.model.Immunization.ImmunizationPerformerComponent

      class ImmunizationPerformerComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -576943815L

      • Serialized Fields

        • actor
          Reference actor
          The practitioner or organization who performed the action.
        • function
          CodeableConcept function
          Describes the type of performance (e.g. ordering provider, administering provider, etc.).

    • Class org.hl7.fhir.r5.model.Immunization.ImmunizationProgramEligibilityComponent

      class ImmunizationProgramEligibilityComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -442289864L

      • Serialized Fields

        • program
          CodeableConcept program
          Indicates which program the patient had their eligility evaluated for.
        • programStatus
          CodeableConcept programStatus
          Indicates the patient's eligility status for for a specific payment program.

    • Class org.hl7.fhir.r5.model.Immunization.ImmunizationProtocolAppliedComponent

      class ImmunizationProtocolAppliedComponent extends BackboneElement implements Serializable
      serialVersionUID:
      660613103L

      • Serialized Fields

        • authority
          Reference authority
          Indicates the authority who published the protocol (e.g. ACIP) that is being followed.
        • doseNumber
          StringType doseNumber
          Nominal position in a series as intended by the practitioner administering the dose.
        • series
          StringType series
          One possible path to achieve presumed immunity against a disease - within the context of an authority.
        • seriesDoses
          StringType seriesDoses
          The recommended number of doses to achieve immunity as intended by the practitioner administering the dose.
        • targetDisease
          List<CodeableConcept> targetDisease
          The vaccine preventable disease the dose is being administered against.

    • Class org.hl7.fhir.r5.model.Immunization.ImmunizationReactionComponent

      class ImmunizationReactionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1181151012L

      • Serialized Fields

    • Class org.hl7.fhir.r5.model.Immunization.ImmunizationStatusCodesEnumFactory

      class ImmunizationStatusCodesEnumFactory extends Object implements Serializable

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

      class ImmunizationEvaluation extends DomainResource implements Serializable
      serialVersionUID:
      1336970813L

      • Serialized Fields

        • authority
          Reference authority
          Indicates the authority who published the protocol (e.g. ACIP).
        • date
          DateTimeType date
          The date the evaluation of the vaccine administration event was performed.
        • description
          MarkdownType description
          Additional information about the evaluation.
        • doseNumber
          StringType doseNumber
          Nominal position in a series as determined by the outcome of the evaluation process.
        • doseStatus
          CodeableConcept doseStatus
          Indicates if the dose is valid or not valid with respect to the published recommendations.
        • doseStatusReason
          List<CodeableConcept> doseStatusReason
          Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.
        • identifier
          List<Identifier> identifier
          A unique identifier assigned to this immunization evaluation record.
        • immunizationEvent
          Reference immunizationEvent
          The vaccine administration event being evaluated.
        • patient
          Reference patient
          The individual for whom the evaluation is being done.
        • series
          StringType series
          One possible path to achieve presumed immunity against a disease - within the context of an authority.
        • seriesDoses
          StringType seriesDoses
          The recommended number of doses to achieve immunity as determined by the outcome of the evaluation process.
        • status
          Enumeration<ImmunizationEvaluation.ImmunizationEvaluationStatusCodes> status
          Indicates the current status of the evaluation of the vaccination administration event.
        • targetDisease
          CodeableConcept targetDisease
          The vaccine preventable disease the dose is being evaluated against.

    • Class org.hl7.fhir.r5.model.ImmunizationEvaluation.ImmunizationEvaluationStatusCodesEnumFactory

      class ImmunizationEvaluationStatusCodesEnumFactory extends Object implements Serializable

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

      class ImmunizationRecommendation extends DomainResource implements Serializable
      serialVersionUID:
      534427937L

    • Class org.hl7.fhir.r5.model.ImmunizationRecommendation.ImmunizationRecommendationRecommendationComponent

      class ImmunizationRecommendationRecommendationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1830552442L

      • Serialized Fields

        • contraindicatedVaccineCode
          List<CodeableConcept> contraindicatedVaccineCode
          Vaccine(s) which should not be used to fulfill the recommendation.
        • dateCriterion
          List<ImmunizationRecommendation.ImmunizationRecommendationRecommendationDateCriterionComponent> dateCriterion
          Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.
        • description
          MarkdownType description
          Contains the description about the protocol under which the vaccine was administered.
        • doseNumber
          StringType doseNumber
          Nominal position of the recommended dose in a series as determined by the evaluation and forecasting process (e.g. dose 2 is the next recommended dose).
        • forecastReason
          List<CodeableConcept> forecastReason
          The reason for the assigned forecast status.
        • forecastStatus
          CodeableConcept forecastStatus
          Indicates the patient status with respect to the path to immunity for the target disease.
        • series
          StringType series
          One possible path to achieve presumed immunity against a disease - within the context of an authority.
        • seriesDoses
          StringType seriesDoses
          The recommended number of doses to achieve immunity as determined by the evaluation and forecasting process.
        • supportingImmunization
          List<Reference> supportingImmunization
          Immunization event history and/or evaluation that supports the status and recommendation.
        • supportingPatientInformation
          List<Reference> supportingPatientInformation
          Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.
        • targetDisease
          List<CodeableConcept> targetDisease
          The targeted disease for the recommendation.
        • vaccineCode
          List<CodeableConcept> vaccineCode
          Vaccine(s) or vaccine group that pertain to the recommendation.

    • Class org.hl7.fhir.r5.model.ImmunizationRecommendation.ImmunizationRecommendationRecommendationDateCriterionComponent

      class ImmunizationRecommendationRecommendationDateCriterionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1036994566L

      • Serialized Fields

        • code
          CodeableConcept code
          Date classification of recommendation. For example, earliest date to give, latest date to give, etc.
        • value
          DateTimeType value
          The date whose meaning is specified by dateCriterion.code.

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

      class ImplementationGuide extends CanonicalResource implements Serializable
      serialVersionUID:
      183592979L

      • 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 implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the implementation guide was last significantly changed. 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 implementation guide changes.
        • definition
          ImplementationGuide.ImplementationGuideDefinitionComponent definition
          The information needed by an IG publisher tool to publish the whole implementation guide.
        • dependsOn
          List<ImplementationGuide.ImplementationGuideDependsOnComponent> dependsOn
          Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.
        • description
          MarkdownType description
          A free text natural language description of the implementation guide from a consumer's perspective.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        • fhirVersion
          List<Enumeration<Enumerations.FHIRVersion>> fhirVersion
          The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.6.0. for this version.
        • global
          List<ImplementationGuide.ImplementationGuideGlobalComponent> global
          A set of profiles that all resources covered by this implementation guide must conform to.
        • identifier
          List<Identifier> identifier
          A formal identifier that is used to identify this implementation guide 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 implementation guide is intended to be used.
        • license
          Enumeration<ImplementationGuide.SPDXLicense> license
          The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'.
        • manifest
          ImplementationGuide.ImplementationGuideManifestComponent manifest
          Information about an assembled implementation guide, created by the publication tooling.
        • name
          StringType name
          A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • packageId
          IdType packageId
          The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care.
        • publisher
          StringType publisher
          The name of the organization or individual responsible for the release and ongoing maintenance of the implementation guide.
        • purpose
          MarkdownType purpose
          Explanation of why this implementation guide is needed and why it has been designed as it has.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this implementation guide. Enables tracking the life-cycle of the content.
        • title
          StringType title
          A short, descriptive, user-friendly title for the implementation guide.
        • url
          UriType url
          An absolute URI that is used to identify this implementation guide 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 an authoritative instance of this implementation guide is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the implementation guide 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 implementation guide instances.
        • version
          StringType version
          The identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide author 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • Class org.hl7.fhir.r5.model.ImplementationGuide.GuidePageGenerationEnumFactory

      class GuidePageGenerationEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.ImplementationGuide.ImplementationGuideDefinitionComponent

      class ImplementationGuideDefinitionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      179051968L

    • Class org.hl7.fhir.r5.model.ImplementationGuide.ImplementationGuideDefinitionGroupingComponent

      class ImplementationGuideDefinitionGroupingComponent extends BackboneElement implements Serializable
      serialVersionUID:
      2116554295L

      • Serialized Fields

        • description
          MarkdownType description
          Human readable text describing the package.
        • name
          StringType name
          The human-readable title to display for the package of resources when rendering the implementation guide.

    • Class org.hl7.fhir.r5.model.ImplementationGuide.ImplementationGuideDefinitionPageComponent

      class ImplementationGuideDefinitionPageComponent extends BackboneElement implements Serializable
      serialVersionUID:
      57473246L

    • Class org.hl7.fhir.r5.model.ImplementationGuide.ImplementationGuideDefinitionParameterComponent

      class ImplementationGuideDefinitionParameterComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1728909245L

      • Serialized Fields

        • code
          Coding code
          A tool-specific code that defines the parameter.
        • value
          StringType value
          Value for named type.

    • Class org.hl7.fhir.r5.model.ImplementationGuide.ImplementationGuideDefinitionResourceComponent

      class ImplementationGuideDefinitionResourceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      804050536L

      • Serialized Fields

        • description
          MarkdownType description
          A description of the reason that a resource has been included in the implementation guide.
        • fhirVersion
          List<Enumeration<Enumerations.FHIRVersion>> fhirVersion
          Indicates the FHIR Version(s) this artifact is intended to apply to. If no versions are specified, the resource is assumed to apply to all the versions stated in ImplementationGuide.fhirVersion.
        • groupingId
          IdType groupingId
          Reference to the id of the grouping this resource appears in.
        • isExample
          BooleanType isExample
          If true, indicates the resource is an example instance.
        • name
          StringType name
          A human assigned name for the resource. All resources SHOULD have a name, but the name may be extracted from the resource (e.g. ValueSet.name).
        • profile
          List<CanonicalType> profile
          If present, indicates profile(s) the instance is valid against.
        • reference
          Reference reference
          Where this resource is found.

    • Class org.hl7.fhir.r5.model.ImplementationGuide.ImplementationGuideDefinitionTemplateComponent

      class ImplementationGuideDefinitionTemplateComponent extends BackboneElement implements Serializable
      serialVersionUID:
      923832457L

      • Serialized Fields

        • code
          CodeType code
          Type of template specified.
        • scope
          StringType scope
          The scope in which the template applies.
        • source
          StringType source
          The source location for the template.

    • Class org.hl7.fhir.r5.model.ImplementationGuide.ImplementationGuideDependsOnComponent

      class ImplementationGuideDependsOnComponent extends BackboneElement implements Serializable
      serialVersionUID:
      487374450L

      • Serialized Fields

        • packageId
          IdType packageId
          The NPM package name for the Implementation Guide that this IG depends on.
        • reason
          MarkdownType reason
          A description explaining the nature of the dependency on the listed IG.
        • uri
          CanonicalType uri
          A canonical reference to the Implementation guide for the dependency.
        • version
          StringType version
          The version of the IG that is depended on, when the correct version is required to understand the IG correctly.

    • Class org.hl7.fhir.r5.model.ImplementationGuide.ImplementationGuideGlobalComponent

      class ImplementationGuideGlobalComponent extends BackboneElement implements Serializable
      serialVersionUID:
      33894666L

      • Serialized Fields

        • profile
          CanonicalType profile
          A reference to the profile that all instances must conform to.
        • type
          CodeType type
          The type of resource that all instances must conform to.

    • Class org.hl7.fhir.r5.model.ImplementationGuide.ImplementationGuideManifestComponent

      class ImplementationGuideManifestComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1881327712L

      • Serialized Fields

        • image
          List<StringType> image
          Indicates a relative path to an image that exists within the IG.
        • other
          List<StringType> other
          Indicates the relative path of an additional non-page, non-image file that is part of the IG - e.g. zip, jar and similar files that could be the target of a hyperlink in a derived IG.
        • page
          List<ImplementationGuide.ManifestPageComponent> page
          Information about a page within the IG.
        • rendering
          UrlType rendering
          A pointer to official web page, PDF or other rendering of the implementation guide.
        • resource
          List<ImplementationGuide.ManifestResourceComponent> resource
          A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.

    • Class org.hl7.fhir.r5.model.ImplementationGuide.ManifestPageComponent

      class ManifestPageComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1920576611L

      • Serialized Fields

        • anchor
          List<StringType> anchor
          The name of an anchor available on the page.
        • name
          StringType name
          Relative path to the page.
        • title
          StringType title
          Label for the page intended for human display.

    • Class org.hl7.fhir.r5.model.ImplementationGuide.ManifestResourceComponent

      class ManifestResourceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      66726063L

      • Serialized Fields

        • isExample
          BooleanType isExample
          If true, indicates the resource is an example instance.
        • profile
          List<CanonicalType> profile
          If present, indicates profile(s) the instance is valid against.
        • reference
          Reference reference
          Where this resource is found.
        • relativePath
          UrlType relativePath
          The relative path for primary page for this resource within the IG.

    • Class org.hl7.fhir.r5.model.ImplementationGuide.SPDXLicenseEnumFactory

      class SPDXLicenseEnumFactory extends Object implements Serializable

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

      class Ingredient extends DomainResource implements Serializable
      serialVersionUID:
      701648703L

      • Serialized Fields

        • allergenicIndicator
          BooleanType allergenicIndicator
          If the ingredient is a known or suspected allergen. Note that this is a property of the substance, so if a reference to a SubstanceDefinition is used to decribe that (rather than just a code), the allergen information should go there, not here.
        • comment
          MarkdownType comment
          A place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying.
        • for_
          List<Reference> for_
          The product which this ingredient is a constituent part of.
        • function
          List<CodeableConcept> function
          A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: antioxidant, alkalizing agent.
        • group
          CodeableConcept group
          A classification of the ingredient according to where in the physical item it tends to be used, such the outer shell of a tablet, inner body or ink.
        • identifier
          Identifier identifier
          The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.
        • manufacturer
          List<Ingredient.IngredientManufacturerComponent> manufacturer
          The organization(s) that manufacture this ingredient. Can be used to indicate: 1) Organizations we are aware of that manufacture this ingredient 2) Specific Manufacturer(s) currently being used 3) Set of organisations allowed to manufacture this ingredient for this product Users must be clear on the application of context relevant to their use case.
        • role
          CodeableConcept role
          A classification of the ingredient identifying its purpose within the product, e.g. active, inactive.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this ingredient. Enables tracking the life-cycle of the content.
        • substance
          Ingredient.IngredientSubstanceComponent substance
          The substance that comprises this ingredient.

    • Class org.hl7.fhir.r5.model.Ingredient.IngredientManufacturerComponent

      class IngredientManufacturerComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1226688097L

      • Serialized Fields

        • manufacturer
          Reference manufacturer
          An organization that manufactures this ingredient.
        • role
          Enumeration<Ingredient.IngredientManufacturerRole> role
          The way in which this manufacturer is associated with the ingredient. For example whether it is a possible one (others allowed), or an exclusive authorized one for this ingredient. Note that this is not the manufacturing process role.

    • Class org.hl7.fhir.r5.model.Ingredient.IngredientManufacturerRoleEnumFactory

      class IngredientManufacturerRoleEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Ingredient.IngredientSubstanceComponent

      class IngredientSubstanceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      538347209L

      • Serialized Fields

        • code
          CodeableReference code
          A code or full resource that represents the ingredient's substance.
        • strength
          List<Ingredient.IngredientSubstanceStrengthComponent> strength
          The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. The allowed repetitions do not represent different strengths, but are different representations - mathematically equivalent - of a single strength.

    • Class org.hl7.fhir.r5.model.Ingredient.IngredientSubstanceStrengthComponent

      class IngredientSubstanceStrengthComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1409093088L

      • Serialized Fields

        • basis
          CodeableConcept basis
          A code that indicates if the strength is, for example, based on the ingredient substance as stated or on the substance base (when the ingredient is a salt).
        • concentration
          DataType concentration
          The strength per unitary volume (or mass).
        • country
          List<CodeableConcept> country
          The country or countries for which the strength range applies.
        • measurementPoint
          StringType measurementPoint
          For when strength is measured at a particular point or distance. There are products where strength is measured at a particular point. For example, the strength of the ingredient in some inhalers is measured at a particular position relative to the point of aerosolization.
        • presentation
          DataType presentation
          The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. Unit of presentation refers to the quantity that the item occurs in e.g. a strength per tablet size, perhaps 'per 20mg' (the size of the tablet). It is not generally normalized as a unitary unit, which would be 'per mg').
        • referenceStrength
          List<Ingredient.IngredientSubstanceStrengthReferenceStrengthComponent> referenceStrength
          Strength expressed in terms of a reference substance. For when the ingredient strength is additionally expressed as equivalent to the strength of some other closely related substance (e.g. salt vs. base). Reference strength represents the strength (quantitative composition) of the active moiety of the active substance. There are situations when the active substance and active moiety are different, therefore both a strength and a reference strength are needed.
        • textConcentration
          StringType textConcentration
          A textual represention of either the whole of the concentration strength or a part of it - with the rest being in Strength.concentration as a ratio.
        • textPresentation
          StringType textPresentation
          A textual represention of either the whole of the presentation strength or a part of it - with the rest being in Strength.presentation as a ratio.

    • Class org.hl7.fhir.r5.model.Ingredient.IngredientSubstanceStrengthReferenceStrengthComponent

      class IngredientSubstanceStrengthReferenceStrengthComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1700529245L

      • Serialized Fields

        • country
          List<CodeableConcept> country
          The country or countries for which the strength range applies.
        • measurementPoint
          StringType measurementPoint
          For when strength is measured at a particular point or distance.
        • strength
          DataType strength
          Strength expressed in terms of a reference substance.
        • substance
          CodeableReference substance
          Relevant reference substance.

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

      class InstantType extends BaseDateTimeType implements Externalizable
      serialVersionUID:
      3L

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

      class InsurancePlan extends DomainResource implements Serializable
      serialVersionUID:
      -292692522L

      • Serialized Fields

        • administeredBy
          Reference administeredBy
          An organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner.
        • alias
          List<StringType> alias
          A list of alternate names that the product is known as, or was known as in the past.
        • contact
          List<ExtendedContactDetail> contact
          The contact details of communication devices available relevant to the specific Insurance Plan/Product. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.
        • coverage
          List<InsurancePlan.InsurancePlanCoverageComponent> coverage
          Details about the coverage offered by the insurance product.
        • coverageArea
          List<Reference> coverageArea
          The geographic region in which a health insurance product's benefits apply.
        • endpoint
          List<Reference> endpoint
          The technical endpoints providing access to services operated for the health insurance product.
        • identifier
          List<Identifier> identifier
          Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server.
        • name
          StringType name
          Official name of the health insurance product as designated by the owner.
        • network
          List<Reference> network
          Reference to the network included in the health insurance product.
        • ownedBy
          Reference ownedBy
          The entity that is providing the health insurance product and underwriting the risk. This is typically an insurance carriers, other third-party payers, or health plan sponsors comonly referred to as 'payers'.
        • period
          Period period
          The period of time that the health insurance product is available.
        • plan
          List<InsurancePlan.InsurancePlanPlanComponent> plan
          Details about an insurance plan.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The current state of the health insurance product.
        • type
          List<CodeableConcept> type
          The kind of health insurance product.

    • Class org.hl7.fhir.r5.model.InsurancePlan.CoverageBenefitComponent

      class CoverageBenefitComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -113658449L

    • Class org.hl7.fhir.r5.model.InsurancePlan.CoverageBenefitLimitComponent

      class CoverageBenefitLimitComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -304318128L

      • Serialized Fields

        • code
          CodeableConcept code
          The specific limit on the benefit.
        • value
          Quantity value
          The maximum amount of a service item a plan will pay for a covered benefit. For examples. wellness visits, or eyeglasses.

    • Class org.hl7.fhir.r5.model.InsurancePlan.InsurancePlanCoverageComponent

      class InsurancePlanCoverageComponent extends BackboneElement implements Serializable
      serialVersionUID:
      79927205L

      • Serialized Fields

        • benefit
          List<InsurancePlan.CoverageBenefitComponent> benefit
          Specific benefits under this type of coverage.
        • network
          List<Reference> network
          Reference to the network that providing the type of coverage.
        • type
          CodeableConcept type
          Type of coverage (Medical; Dental; Mental Health; Substance Abuse; Vision; Drug; Short Term; Long Term Care; Hospice; Home Health).

    • Class org.hl7.fhir.r5.model.InsurancePlan.InsurancePlanPlanComponent

      class InsurancePlanPlanComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -782831938L

    • Class org.hl7.fhir.r5.model.InsurancePlan.InsurancePlanPlanGeneralCostComponent

      class InsurancePlanPlanGeneralCostComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1563949866L

      • Serialized Fields

        • comment
          StringType comment
          Additional information about the general costs associated with this plan.
        • cost
          Money cost
          Value of the cost.
        • groupSize
          PositiveIntType groupSize
          Number of participants enrolled in the plan.
        • type
          CodeableConcept type
          Type of cost.

    • Class org.hl7.fhir.r5.model.InsurancePlan.InsurancePlanPlanSpecificCostComponent

      class InsurancePlanPlanSpecificCostComponent extends BackboneElement implements Serializable
      serialVersionUID:
      922585525L

      • Serialized Fields

        • benefit
          List<InsurancePlan.PlanBenefitComponent> benefit
          List of the specific benefits under this category of benefit.
        • category
          CodeableConcept category
          General category of benefit (Medical; Dental; Vision; Drug; Mental Health; Substance Abuse; Hospice, Home Health).

    • Class org.hl7.fhir.r5.model.InsurancePlan.PlanBenefitComponent

      class PlanBenefitComponent extends BackboneElement implements Serializable
      serialVersionUID:
      792296200L

      • Serialized Fields

    • Class org.hl7.fhir.r5.model.InsurancePlan.PlanBenefitCostComponent

      class PlanBenefitCostComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -340688733L

      • Serialized Fields

        • applicability
          CodeableConcept applicability
          Whether the cost applies to in-network or out-of-network providers (in-network; out-of-network; other).
        • qualifiers
          List<CodeableConcept> qualifiers
          Additional information about the cost, such as information about funding sources (e.g. HSA, HRA, FSA, RRA).
        • type
          CodeableConcept type
          Type of cost (copay; individual cap; family cap; coinsurance; deductible).
        • value
          Quantity value
          The actual cost value. (some of the costs may be represented as percentages rather than currency, e.g. 10% coinsurance).

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

      class Integer64Type extends PrimitiveType<Long> implements Externalizable
      serialVersionUID:
      3L

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

      class IntegerType extends PrimitiveType<Integer> implements Externalizable
      serialVersionUID:
      3L

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

      class InventoryItem extends DomainResource implements Serializable
      serialVersionUID:
      2127201564L

    • Class org.hl7.fhir.r5.model.InventoryItem.InventoryItemAssociationComponent

      class InventoryItemAssociationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1001386921L

      • Serialized Fields

        • associationType
          CodeableConcept associationType
          This attribute defined the type of association when establishing associations or relations between items, e.g. 'packaged within' or 'used with' or 'to be mixed with.
        • quantity
          Ratio quantity
          The quantity of the related product in this product - Numerator is the quantity of the related product. Denominator is the quantity of the present product. For example a value of 20 means that this product contains 20 units of the related product; a value of 1:20 means the inverse - that the contained product contains 20 units of the present product.
        • relatedItem
          Reference relatedItem
          The related item or product.

    • Class org.hl7.fhir.r5.model.InventoryItem.InventoryItemCharacteristicComponent

      class InventoryItemCharacteristicComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -642436065L

      • Serialized Fields

        • characteristicType
          CodeableConcept characteristicType
          The type of characteristic that is being defined.
        • value
          DataType value
          The value of the attribute.

    • Class org.hl7.fhir.r5.model.InventoryItem.InventoryItemDescriptionComponent

      class InventoryItemDescriptionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -803271414L

      • Serialized Fields

        • description
          StringType description
          Textual description of the item.
        • language
          Enumeration<Enumerations.CommonLanguages> language
          The language for the item description, when an item must be described in different languages and those languages may be authoritative and not translations of a 'main' language.

    • Class org.hl7.fhir.r5.model.InventoryItem.InventoryItemInstanceComponent

      class InventoryItemInstanceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      657936980L

      • Serialized Fields

        • expiry
          DateTimeType expiry
          The expiry date or date and time for the product.
        • identifier
          List<Identifier> identifier
          The identifier for the physical instance, typically a serial number.
        • location
          Reference location
          The location that the item is associated with.
        • lotNumber
          StringType lotNumber
          The lot or batch number of the item.
        • subject
          Reference subject
          The subject that the item is associated with.

    • Class org.hl7.fhir.r5.model.InventoryItem.InventoryItemNameComponent

      class InventoryItemNameComponent extends BackboneElement implements Serializable
      serialVersionUID:
      2074178414L

      • Serialized Fields

    • Class org.hl7.fhir.r5.model.InventoryItem.InventoryItemResponsibleOrganizationComponent

      class InventoryItemResponsibleOrganizationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -575091539L

      • Serialized Fields

        • organization
          Reference organization
          An organization that has an association with the item, e.g. manufacturer, distributor, responsible, etc.
        • role
          CodeableConcept role
          The role of the organization e.g. manufacturer, distributor, etc.

    • Class org.hl7.fhir.r5.model.InventoryItem.InventoryItemStatusCodesEnumFactory

      class InventoryItemStatusCodesEnumFactory extends Object implements Serializable

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

      class InventoryReport extends DomainResource implements Serializable
      serialVersionUID:
      539262671L

    • Class org.hl7.fhir.r5.model.InventoryReport.InventoryCountTypeEnumFactory

      class InventoryCountTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.InventoryReport.InventoryReportInventoryListingComponent

      class InventoryReportInventoryListingComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1766136476L

    • Class org.hl7.fhir.r5.model.InventoryReport.InventoryReportInventoryListingItemComponent

      class InventoryReportInventoryListingItemComponent extends BackboneElement implements Serializable
      serialVersionUID:
      566223460L

      • Serialized Fields

        • category
          CodeableConcept category
          The inventory category or classification of the items being reported. This is meant not for defining the product, but for inventory categories e.g. 'pending recount' or 'damaged'.
        • item
          CodeableReference item
          The code or reference to the item type.
        • quantity
          Quantity quantity
          The quantity of the item or items being reported.

    • Class org.hl7.fhir.r5.model.InventoryReport.InventoryReportStatusEnumFactory

      class InventoryReportStatusEnumFactory extends Object implements Serializable

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

      class Invoice extends DomainResource implements Serializable
      serialVersionUID:
      6346282L

      • Serialized Fields

        • account
          Reference account
          Account which is supposed to be balanced with this Invoice.
        • cancelledReason
          StringType cancelledReason
          In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).
        • creation
          DateTimeType creation
          Date/time(s) of when this Invoice was posted.
        • date
          DateTimeType date
          Depricared by the element below.
        • identifier
          List<Identifier> identifier
          Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments.
        • issuer
          Reference issuer
          The organizationissuing the Invoice.
        • lineItem
          List<Invoice.InvoiceLineItemComponent> lineItem
          Each line item represents one charge for goods and services rendered. Details such.ofType(date), code and amount are found in the referenced ChargeItem resource.
        • note
          List<Annotation> note
          Comments made about the invoice by the issuer, subject, or other participants.
        • participant
          List<Invoice.InvoiceParticipantComponent> participant
          Indicates who or what performed or participated in the charged service.
        • paymentTerms
          MarkdownType paymentTerms
          Payment details such as banking details, period of payment, deductibles, methods of payment.
        • period
          DataType period
          Date/time(s) range of services included in this invoice.
        • recipient
          Reference recipient
          The individual or Organization responsible for balancing of this invoice.
        • status
          Enumeration<Invoice.InvoiceStatus> status
          The current state of the Invoice.
        • subject
          Reference subject
          The individual or set of individuals receiving the goods and services billed in this invoice.
        • totalGross
          Money totalGross
          Invoice total, tax included.
        • totalNet
          Money totalNet
          Invoice total , taxes excluded.
        • totalPriceComponent
          List<MonetaryComponent> totalPriceComponent
          The total amount for the Invoice may be calculated as the sum of the line items with surcharges/deductions that apply in certain conditions. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the total price was calculated.
        • type
          CodeableConcept type
          Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary).

    • Class org.hl7.fhir.r5.model.Invoice.InvoiceLineItemComponent

      class InvoiceLineItemComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -9393053L

      • Serialized Fields

        • chargeItem
          DataType chargeItem
          The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference.
        • priceComponent
          List<MonetaryComponent> priceComponent
          The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice as to how the prices have been calculated.
        • sequence
          PositiveIntType sequence
          Sequence in which the items appear on the invoice.
        • serviced
          DataType serviced
          Date/time(s) range when this service was delivered or completed.

    • Class org.hl7.fhir.r5.model.Invoice.InvoiceParticipantComponent

      class InvoiceParticipantComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1684441509L

      • Serialized Fields

        • actor
          Reference actor
          The device, practitioner, etc. who performed or participated in the service.
        • role
          CodeableConcept role
          Describes the type of involvement (e.g. transcriptionist, creator etc.). If the invoice has been created automatically, the Participant may be a billing engine or another kind of device.

    • Class org.hl7.fhir.r5.model.Invoice.InvoiceStatusEnumFactory

      class InvoiceStatusEnumFactory extends Object implements Serializable

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

      class Library extends MetadataResource implements Serializable
      serialVersionUID:
      1098204872L

      • 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.
        • contact
          List<ContactDetail> contact
          Contact details to assist a user in finding and communicating with the publisher.
        • content
          List<Attachment> content
          The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.
        • copyright
          MarkdownType copyright
          A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • dataRequirement
          List<DataRequirement> dataRequirement
          Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.
        • date
          DateTimeType date
          The date (and optionally time) when the library was last significantly changed. 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 library changes.
        • description
          MarkdownType description
          A free text natural language description of the library from a consumer's perspective.
        • editor
          List<ContactDetail> editor
          An individual or organization primarily responsible for internal coherence of the content.
        • effectivePeriod
          Period effectivePeriod
          The period during which the library content was or is planned to be in active use.
        • endorser
          List<ContactDetail> endorser
          An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this library 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 library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.
        • jurisdiction
          List<CodeableConcept> jurisdiction
          A legal or geographic region in which the library 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 library. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • parameter
          List<ParameterDefinition> parameter
          The parameter element defines parameters used by the library.
        • publisher
          StringType publisher
          The name of the organization or individual responsible for the release and ongoing maintenance of the library.
        • purpose
          MarkdownType purpose
          Explanation of why this library is needed and why it has been designed as it has.
        • relatedArtifact
          List<RelatedArtifact> relatedArtifact
          Related artifacts such as additional documentation, justification, or bibliographic references.
        • reviewer
          List<ContactDetail> reviewer
          An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this library. Enables tracking the life-cycle of the content.
        • subject
          DataType subject
          A code or group definition that describes the intended subject of the contents of the library.
        • subtitle
          StringType subtitle
          An explanatory or alternate title for the library giving additional information about its content.
        • title
          StringType title
          A short, descriptive, user-friendly title for the library.
        • topic
          List<CodeableConcept> topic
          Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching.
        • type
          CodeableConcept type
          Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.
        • url
          UriType url
          An absolute URI that is used to identify this library 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 an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers.
        • usage
          MarkdownType usage
          A detailed description of how the library 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 library instances.
        • version
          StringType version
          The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library 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 artifacts.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

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

      class Linkage extends DomainResource implements Serializable
      serialVersionUID:
      810520886L

      • Serialized Fields

        • active
          BooleanType active
          Indicates whether the asserted set of linkages are considered to be "in effect".
        • author
          Reference author
          Identifies the user or organization responsible for asserting the linkages as well as the user or organization who establishes the context in which the nature of each linkage is evaluated.
        • item
          List<Linkage.LinkageItemComponent> item
          Identifies which record considered as the reference to the same real-world occurrence as well as how the items should be evaluated within the collection of linked items.

    • Class org.hl7.fhir.r5.model.Linkage.LinkageItemComponent

      class LinkageItemComponent extends BackboneElement implements Serializable
      serialVersionUID:
      527428511L

      • Serialized Fields

        • resource
          Reference resource
          The resource instance being linked as part of the group.
        • type
          Enumeration<Linkage.LinkageType> type
          Distinguishes which item is "source of truth" (if any) and which items are no longer considered to be current representations.

    • Class org.hl7.fhir.r5.model.Linkage.LinkageTypeEnumFactory

      class LinkageTypeEnumFactory extends Object implements Serializable

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

      class ListResource extends DomainResource implements Serializable
      serialVersionUID:
      -2099967050L

      • Serialized Fields

        • code
          CodeableConcept code
          This code defines the purpose of the list - why it was created.
        • date
          DateTimeType date
          Date list was last reviewed/revised and determined to be 'current'.
        • emptyReason
          CodeableConcept emptyReason
          If the list is empty, why the list is empty.
        • encounter
          Reference encounter
          The encounter that is the context in which this list was created.
        • entry
          List<ListResource.ListResourceEntryComponent> entry
          Entries in this list.
        • identifier
          List<Identifier> identifier
          Identifier for the List assigned for business purposes outside the context of FHIR.
        • mode
          Enumeration<Enumerations.ListMode> mode
          How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
        • note
          List<Annotation> note
          Comments that apply to the overall list.
        • orderedBy
          CodeableConcept orderedBy
          What order applies to the items in the list.
        • source
          Reference source
          The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.
        • status
          Enumeration<ListResource.ListStatus> status
          Indicates the current state of this list.
        • subject
          List<Reference> subject
          The common subject(s) (or patient(s)) of the resources that are in the list if there is one (or a set of subjects).
        • title
          StringType title
          A label for the list assigned by the author.

    • Class org.hl7.fhir.r5.model.ListResource.ListResourceEntryComponent

      class ListResourceEntryComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -872672029L

      • Serialized Fields

        • date
          DateTimeType date
          When this item was added to the list.
        • deleted
          BooleanType deleted
          True if this item is marked as deleted in the list.
        • flag
          CodeableConcept flag
          The flag allows the system constructing the list to indicate the role and significance of the item in the list.
        • item
          Reference item
          A reference to the actual resource from which data was derived.

    • Class org.hl7.fhir.r5.model.ListResource.ListStatusEnumFactory

      class ListStatusEnumFactory extends Object implements Serializable

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

      class Location extends DomainResource implements Serializable
      serialVersionUID:
      1238993068L

      • Serialized Fields

        • address
          Address address
          Physical location.
        • alias
          List<StringType> alias
          A list of alternate names that the location is known as, or was known as, in the past.
        • characteristic
          List<CodeableConcept> characteristic
          Collection of characteristics (attributes).
        • contact
          List<ExtendedContactDetail> contact
          The contact details of communication devices available at the location. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.
        • description
          MarkdownType description
          Description of the Location, which helps in finding or referencing the place.
        • endpoint
          List<Reference> endpoint
          Technical endpoints providing access to services operated for the location.
        • form
          CodeableConcept form
          Physical form of the location, e.g. building, room, vehicle, road, virtual.
        • hoursOfOperation
          List<Availability> hoursOfOperation
          What days/times during a week is this location usually open, and any exceptions where the location is not available.
        • identifier
          List<Identifier> identifier
          Unique code or number identifying the location to its users.
        • managingOrganization
          Reference managingOrganization
          The organization responsible for the provisioning and upkeep of the location.
        • mode
          Enumeration<Location.LocationMode> mode
          Indicates whether a resource instance represents a specific location or a class of locations.
        • name
          StringType name
          Name of the location as used by humans. Does not need to be unique.
        • operationalStatus
          Coding operationalStatus
          The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.
        • partOf
          Reference partOf
          Another Location of which this Location is physically a part of.
        • position
          Location.LocationPositionComponent position
          The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
        • status
          Enumeration<Location.LocationStatus> status
          The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
        • type
          List<CodeableConcept> type
          Indicates the type of function performed at the location.
        • virtualService
          List<VirtualServiceDetail> virtualService
          Connection details of a virtual service (e.g. shared conference call facility with dedicated number/details).

    • Class org.hl7.fhir.r5.model.Location.LocationModeEnumFactory

      class LocationModeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Location.LocationPositionComponent

      class LocationPositionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -74276134L

      • Serialized Fields

        • altitude
          DecimalType altitude
          Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes on Location main page).
        • latitude
          DecimalType latitude
          Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes on Location main page).
        • longitude
          DecimalType longitude
          Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes on Location main page).

    • Class org.hl7.fhir.r5.model.Location.LocationStatusEnumFactory

      class LocationStatusEnumFactory extends Object implements Serializable

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

      class ManufacturedItemDefinition extends DomainResource implements Serializable
      serialVersionUID:
      516510494L

    • Class org.hl7.fhir.r5.model.ManufacturedItemDefinition.ManufacturedItemDefinitionComponentComponent

      class ManufacturedItemDefinitionComponentComponent extends BackboneElement implements Serializable
      serialVersionUID:
      537950590L

    • Class org.hl7.fhir.r5.model.ManufacturedItemDefinition.ManufacturedItemDefinitionComponentConstituentComponent

      class ManufacturedItemDefinitionComponentConstituentComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -708786069L

      • Serialized Fields

        • amount
          List<Quantity> amount
          The measurable amount of the substance, expressable in different ways (e.g. by mass or volume).
        • function
          List<CodeableConcept> function
          The function of this constituent within the component e.g. binder.
        • hasIngredient
          List<CodeableReference> hasIngredient
          The ingredient that is the constituent of the given component.
        • location
          List<CodeableConcept> location
          The physical location of the constituent/ingredient within the component. Example ? if the component is the bead in the capsule, then the location would be where the ingredient resides within the product part ? intragranular, extra-granular, etc.

    • Class org.hl7.fhir.r5.model.ManufacturedItemDefinition.ManufacturedItemDefinitionPropertyComponent

      class ManufacturedItemDefinitionPropertyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1659186716L

      • Serialized Fields

        • type
          CodeableConcept type
          A code expressing the type of characteristic.
        • value
          DataType value
          A value for the characteristic.

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

      class MarkdownType extends StringType implements Externalizable
      serialVersionUID:
      3L

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

      class MarketingStatus extends BackboneType implements Serializable
      serialVersionUID:
      -1445736863L

      • Serialized Fields

        • country
          CodeableConcept country
          The country in which the marketing authorization has been granted shall be specified It should be specified using the ISO 3166 ? 1 alpha-2 code elements.
        • dateRange
          Period dateRange
          The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE ?Placed on the market? refers to the release of the Medicinal Product into the distribution chain.
        • jurisdiction
          CodeableConcept jurisdiction
          Where a Medicines Regulatory Agency has granted a marketing authorization for which specific provisions within a jurisdiction apply, the jurisdiction can be specified using an appropriate controlled terminology The controlled term and the controlled term identifier shall be specified.
        • restoreDate
          DateTimeType restoreDate
          The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE ?Placed on the market? refers to the release of the Medicinal Product into the distribution chain.
        • status
          CodeableConcept status
          This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples.

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

      class Measure extends MetadataResource implements Serializable
      serialVersionUID:
      -1907068641L

      • 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.
        • basis
          Enumeration<Enumerations.FHIRTypes> basis
          The population basis specifies the type of elements in the population. For a subject-based measure, this is boolean (because the subject and the population basis are the same, and the population criteria define yes/no values for each individual in the population). For measures that have a population basis that is different than the subject, this element specifies the type of the population basis. For example, an encounter-based measure has a subject of Patient and a population basis of Encounter, and the population criteria all return lists of Encounters.
        • clinicalRecommendationStatement
          MarkdownType clinicalRecommendationStatement
          Provides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.
        • compositeScoring
          CodeableConcept compositeScoring
          If this is a composite measure, the scoring method used to combine the component measures to determine the composite score.
        • 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 measure and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the measure.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the measure was last significantly changed. 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 measure changes.
        • description
          MarkdownType description
          A free text natural language description of the measure from a consumer's perspective.
        • disclaimer
          MarkdownType disclaimer
          Notices and disclaimers regarding the use of the measure or related to intellectual property (such as code systems) referenced by the measure.
        • editor
          List<ContactDetail> editor
          An individual or organization primarily responsible for internal coherence of the content.
        • effectivePeriod
          Period effectivePeriod
          The period during which the measure content was or is planned to be in active use.
        • endorser
          List<ContactDetail> endorser
          An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this measure is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        • group
          List<Measure.MeasureGroupComponent> group
          A group of population criteria for the measure.
        • guidance
          MarkdownType guidance
          Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.
        • identifier
          List<Identifier> identifier
          A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance.
        • improvementNotation
          CodeableConcept improvementNotation
          Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range).
        • jurisdiction
          List<CodeableConcept> jurisdiction
          A legal or geographic region in which the measure 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.
        • library
          List<CanonicalType> library
          A reference to a Library resource containing the formal logic used by the measure.
        • name
          StringType name
          A natural language name identifying the measure. 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 responsible for the release and ongoing maintenance of the measure.
        • purpose
          MarkdownType purpose
          Explanation of why this measure is needed and why it has been designed as it has.
        • rateAggregation
          MarkdownType rateAggregation
          Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result.
        • rationale
          MarkdownType rationale
          Provides a succinct statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.
        • relatedArtifact
          List<RelatedArtifact> relatedArtifact
          Related artifacts such as additional documentation, justification, or bibliographic references.
        • reviewer
          List<ContactDetail> reviewer
          An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.
        • riskAdjustment
          MarkdownType riskAdjustment
          A description of the risk adjustment factors that may impact the resulting score for the measure and how they may be accounted for when computing and reporting measure results.
        • scoring
          CodeableConcept scoring
          Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented.
        • scoringUnit
          CodeableConcept scoringUnit
          Defines the expected units of measure for the measure score. This element SHOULD be specified as a UCUM unit.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this measure. Enables tracking the life-cycle of the content.
        • subject
          DataType subject
          The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything.
        • subtitle
          StringType subtitle
          An explanatory or alternate title for the measure giving additional information about its content.
        • supplementalData
          List<Measure.MeasureSupplementalDataComponent> supplementalData
          The supplemental data criteria for the measure report, specified as either the name of a valid CQL expression within a referenced library, or a valid FHIR Resource Path.
        • term
          List<Measure.MeasureTermComponent> term
          Provides a description of an individual term used within the measure.
        • title
          StringType title
          A short, descriptive, user-friendly title for the measure.
        • topic
          List<CodeableConcept> topic
          Descriptive topics related to the content of the measure. Topics provide a high-level categorization grouping types of measures that can be useful for filtering and searching.
        • type
          List<CodeableConcept> type
          Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization.
        • url
          UriType url
          An absolute URI that is used to identify this measure 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 an authoritative instance of this measure is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the measure is stored on different servers.
        • usage
          MarkdownType usage
          A detailed description, from a clinical perspective, of how the measure is used.
        • 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 measure instances.
        • version
          StringType version
          The identifier that is used to identify this version of the measure when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the measure 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 artifacts.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • Class org.hl7.fhir.r5.model.Measure.MeasureGroupComponent

      class MeasureGroupComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1459308752L

      • Serialized Fields

        • basis
          Enumeration<Enumerations.FHIRTypes> basis
          The population basis specifies the type of elements in the population. For a subject-based measure, this is boolean (because the subject and the population basis are the same, and the population criteria define yes/no values for each individual in the population). For measures that have a population basis that is different than the subject, this element specifies the type of the population basis. For example, an encounter-based measure has a subject of Patient and a population basis of Encounter, and the population criteria all return lists of Encounters.
        • code
          CodeableConcept code
          Indicates a meaning for the group. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing groups to be correlated across measures.
        • description
          MarkdownType description
          The human readable description of this population group.
        • improvementNotation
          CodeableConcept improvementNotation
          Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range).
        • library
          List<CanonicalType> library
          A reference to a Library resource containing the formal logic used by the measure group.
        • linkId
          StringType linkId
          An identifier that is unique within the Measure allowing linkage to the equivalent item in a MeasureReport resource.
        • population
          List<Measure.MeasureGroupPopulationComponent> population
          A population criteria for the measure.
        • rateAggregation
          MarkdownType rateAggregation
          Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result.
        • scoring
          CodeableConcept scoring
          Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented.
        • scoringUnit
          CodeableConcept scoringUnit
          Defines the expected units of measure for the measure score. This element SHOULD be specified as a UCUM unit.
        • stratifier
          List<Measure.MeasureGroupStratifierComponent> stratifier
          The stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.
        • subject
          DataType subject
          The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything.
        • type
          List<CodeableConcept> type
          Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization.

    • Class org.hl7.fhir.r5.model.Measure.MeasureGroupPopulationComponent

      class MeasureGroupPopulationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1233952485L

      • Serialized Fields

        • aggregateMethod
          CodeableConcept aggregateMethod
          Specifies which method should be used to aggregate measure observation values. For most scoring types, this is implied by scoring (e.g. a proportion measure counts members of the populations). For continuous variables, however, this information must be specified to ensure correct calculation.
        • code
          CodeableConcept code
          The type of population criteria.
        • criteria
          Expression criteria
          An expression that specifies the criteria for the population, typically the name of an expression in a library.
        • description
          MarkdownType description
          The human readable description of this population criteria.
        • groupDefinition
          Reference groupDefinition
          A Group resource that defines this population as a set of characteristics.
        • inputPopulationId
          StringType inputPopulationId
          The id of a population element in this measure that provides the input for this population criteria. In most cases, the scoring structure of the measure implies specific relationships (e.g. the Numerator uses the Denominator as the source in a proportion scoring). In some cases, however, multiple possible choices exist and must be resolved explicitly. For example in a ratio measure with multiple initial populations, the denominator must specify which population should be used as the starting point.
        • linkId
          StringType linkId
          An identifier that is unique within the Measure allowing linkage to the equivalent population in a MeasureReport resource.

    • Class org.hl7.fhir.r5.model.Measure.MeasureGroupStratifierComponent

      class MeasureGroupStratifierComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1169588840L

      • Serialized Fields

        • code
          CodeableConcept code
          Indicates a meaning for the stratifier. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing stratifiers to be correlated across measures.
        • component
          List<Measure.MeasureGroupStratifierComponentComponent> component
          A component of the stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.
        • criteria
          Expression criteria
          An expression that specifies the criteria for the stratifier. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element.
        • description
          MarkdownType description
          The human readable description of this stratifier criteria.
        • groupDefinition
          Reference groupDefinition
          A Group resource that defines this population as a set of characteristics.
        • linkId
          StringType linkId
          An identifier that is unique within the Measure allowing linkage to the equivalent item in a MeasureReport resource.

    • Class org.hl7.fhir.r5.model.Measure.MeasureGroupStratifierComponentComponent

      class MeasureGroupStratifierComponentComponent extends BackboneElement implements Serializable
      serialVersionUID:
      744342583L

      • Serialized Fields

        • code
          CodeableConcept code
          Indicates a meaning for the stratifier component. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing stratifiers to be correlated across measures.
        • criteria
          Expression criteria
          An expression that specifies the criteria for this component of the stratifier. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element.
        • description
          MarkdownType description
          The human readable description of this stratifier criteria component.
        • groupDefinition
          Reference groupDefinition
          A Group resource that defines this population as a set of characteristics.
        • linkId
          StringType linkId
          An identifier that is unique within the Measure allowing linkage to the equivalent item in a MeasureReport resource.

    • Class org.hl7.fhir.r5.model.Measure.MeasureSupplementalDataComponent

      class MeasureSupplementalDataComponent extends BackboneElement implements Serializable
      serialVersionUID:
      745484444L

      • Serialized Fields

        • code
          CodeableConcept code
          Indicates a meaning for the supplemental data. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing supplemental data to be correlated across measures.
        • criteria
          Expression criteria
          The criteria for the supplemental data. This is typically the name of a valid expression defined within a referenced library, but it may also be a path to a specific data element. The criteria defines the data to be returned for this element.
        • description
          MarkdownType description
          The human readable description of this supplemental data.
        • linkId
          StringType linkId
          An identifier that is unique within the Measure allowing linkage to the equivalent item in a MeasureReport resource.
        • usage
          List<CodeableConcept> usage
          An indicator of the intended usage for the supplemental data element. Supplemental data indicates the data is additional information requested to augment the measure information. Risk adjustment factor indicates the data is additional information used to calculate risk adjustment factors when applying a risk model to the measure calculation.

    • Class org.hl7.fhir.r5.model.Measure.MeasureTermComponent

      class MeasureTermComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -25931622L

      • Serialized Fields

        • code
          CodeableConcept code
          A codeable representation of the defined term.
        • definition
          MarkdownType definition
          Provides a definition for the term as used within the measure.

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

      class MeasureReport extends DomainResource implements Serializable
      serialVersionUID:
      962133374L

      • Serialized Fields

        • dataUpdateType
          Enumeration<MeasureReport.SubmitDataUpdateType> dataUpdateType
          Indicates whether the data submitted in a data-exchange report represents a snapshot or incremental update. A snapshot update replaces all previously submitted data for the receiver, whereas an incremental update represents only updated and/or changed data and should be applied as a differential update to the existing submitted data for the receiver.
        • date
          DateTimeType date
          The date this measure was calculated.
        • evaluatedResource
          List<Reference> evaluatedResource
          Evaluated resources are used to capture what data was involved in the calculation of a measure. This usage is only allowed for individual reports to ensure that the size of the MeasureReport resource is bounded.
        • group
          List<MeasureReport.MeasureReportGroupComponent> group
          The results of the calculation, one for each population group in the measure.
        • identifier
          List<Identifier> identifier
          A formal identifier that is used to identify this MeasureReport when it is represented in other formats or referenced in a specification, model, design or an instance.
        • improvementNotation
          CodeableConcept improvementNotation
          Whether improvement in the measure is noted by an increase or decrease in the measure score.
        • inputParameters
          Reference inputParameters
          A reference to a Parameters resource (typically represented using a contained resource) that represents any input parameters that were provided to the operation that generated the report.
        • location
          Reference location
          A reference to the location for which the data is being reported.
        • measure
          CanonicalType measure
          A reference to the Measure that was calculated to produce this report.
        • period
          Period period
          The reporting period for which the report was calculated.
        • reporter
          Reference reporter
          The individual or organization that is reporting the data.
        • reportingVendor
          Reference reportingVendor
          A reference to the vendor who queried the data, calculated results and/or generated the report. The ?reporting vendor? is intended to represent the submitting entity when it is not the same as the reporting entity. This extension is used when the Receiver is interested in getting vendor information in the report.
        • scoring
          CodeableConcept scoring
          Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented. It is expected to be the same as the scoring element on the referenced Measure.
        • status
          Enumeration<MeasureReport.MeasureReportStatus> status
          The MeasureReport status. No data will be available until the MeasureReport status is complete.
        • subject
          Reference subject
          Optional subject identifying the individual or individuals the report is for.
        • supplementalData
          List<Reference> supplementalData
          A reference to a Resource that represents additional information collected for the report. If the value of the supplemental data is not a Resource (i.e. evaluating the supplementalData expression for this case in the measure results in a value that is not a FHIR Resource), it is reported as a reference to a contained Observation resource.
        • type
          Enumeration<MeasureReport.MeasureReportType> type
          The type of measure report. This may be an individual report, which provides the score for the measure for an individual member of the population; a subject-listing, which returns the list of members that meet the various criteria in the measure; a summary report, which returns a population count for each of the criteria in the measure; or a data-collection, which enables the MeasureReport to be used to exchange the data-of-interest for a quality measure.

    • Class org.hl7.fhir.r5.model.MeasureReport.MeasureReportGroupComponent

      class MeasureReportGroupComponent extends BackboneElement implements Serializable
      serialVersionUID:
      438553747L

      • Serialized Fields

        • code
          CodeableConcept code
          The meaning of the population group as defined in the measure definition.
        • linkId
          StringType linkId
          The group from the Measure that corresponds to this group in the MeasureReport resource.
        • measureScore
          DataType measureScore
          The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group.
        • population
          List<MeasureReport.MeasureReportGroupPopulationComponent> population
          The populations that make up the population group, one for each type of population appropriate for the measure.
        • stratifier
          List<MeasureReport.MeasureReportGroupStratifierComponent> stratifier
          When a measure includes multiple stratifiers, there will be a stratifier group for each stratifier defined by the measure.
        • subject
          Reference subject
          Optional subject identifying the individual or individuals the report is for.

    • Class org.hl7.fhir.r5.model.MeasureReport.MeasureReportGroupPopulationComponent

      class MeasureReportGroupPopulationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -203678073L

      • Serialized Fields

        • code
          CodeableConcept code
          The type of the population.
        • count
          IntegerType count
          The number of members of the population.
        • linkId
          StringType linkId
          The population from the Measure that corresponds to this population in the MeasureReport resource.
        • subjectReport
          List<Reference> subjectReport
          A reference to an individual level MeasureReport resource for a member of the population.
        • subjectResults
          Reference subjectResults
          This element refers to a List of individual level MeasureReport resources, one for each subject in this population.
        • subjects
          Reference subjects
          Optional Group identifying the individuals that make up the population.

    • Class org.hl7.fhir.r5.model.MeasureReport.MeasureReportGroupStratifierComponent

      class MeasureReportGroupStratifierComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1021076195L

      • Serialized Fields

        • code
          CodeableConcept code
          The meaning of this stratifier, as defined in the measure definition.
        • linkId
          StringType linkId
          The stratifier from the Measure that corresponds to this stratifier in the MeasureReport resource.
        • stratum
          List<MeasureReport.StratifierGroupComponent> stratum
          This element contains the results for a single stratum within the stratifier. For example, when stratifying on administrative gender, there will be four strata, one for each possible gender value.

    • Class org.hl7.fhir.r5.model.MeasureReport.MeasureReportStatusEnumFactory

      class MeasureReportStatusEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.MeasureReport.MeasureReportTypeEnumFactory

      class MeasureReportTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.MeasureReport.StratifierGroupComponent

      class StratifierGroupComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1713783491L

      • Serialized Fields

        • component
          List<MeasureReport.StratifierGroupComponentComponent> component
          A stratifier component value.
        • measureScore
          DataType measureScore
          The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum.
        • population
          List<MeasureReport.StratifierGroupPopulationComponent> population
          The populations that make up the stratum, one for each type of population appropriate to the measure.
        • value
          DataType value
          The value for this stratum, expressed as a CodeableConcept. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is unique.

    • Class org.hl7.fhir.r5.model.MeasureReport.StratifierGroupComponentComponent

      class StratifierGroupComponentComponent extends BackboneElement implements Serializable
      serialVersionUID:
      368088311L

      • Serialized Fields

        • code
          CodeableConcept code
          The code for the stratum component value.
        • linkId
          StringType linkId
          The stratifier component from the Measure that corresponds to this stratifier component in the MeasureReport resource.
        • value
          DataType value
          The stratum component value.

    • Class org.hl7.fhir.r5.model.MeasureReport.StratifierGroupPopulationComponent

      class StratifierGroupPopulationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -203678073L

      • Serialized Fields

        • code
          CodeableConcept code
          The type of the population.
        • count
          IntegerType count
          The number of members of the population in this stratum.
        • linkId
          StringType linkId
          The population from the Measure that corresponds to this population in the MeasureReport resource.
        • subjectReport
          List<Reference> subjectReport
          A reference to an individual level MeasureReport resource for a member of the population.
        • subjectResults
          Reference subjectResults
          This element refers to a List of individual level MeasureReport resources, one for each subject in this population in this stratum.
        • subjects
          Reference subjects
          Optional Group identifying the individuals that make up the population.

    • Class org.hl7.fhir.r5.model.MeasureReport.SubmitDataUpdateTypeEnumFactory

      class SubmitDataUpdateTypeEnumFactory extends Object implements Serializable

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

      class Medication extends DomainResource implements Serializable
      serialVersionUID:
      603813239L

      • Serialized Fields

        • batch
          Medication.MedicationBatchComponent batch
          Information that only applies to packages (not products).
        • code
          CodeableConcept code
          A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.
        • definition
          Reference definition
          A reference to a knowledge resource that provides more information about this medication.
        • doseForm
          CodeableConcept doseForm
          Describes the form of the item. Powder; tablets; capsule.
        • identifier
          List<Identifier> identifier
          Business identifier for this medication.
        • ingredient
          List<Medication.MedicationIngredientComponent> ingredient
          Identifies a particular constituent of interest in the product.
        • marketingAuthorizationHolder
          Reference marketingAuthorizationHolder
          The company or other legal entity that has authorization, from the appropriate drug regulatory authority, to market a medicine in one or more jurisdictions. Typically abbreviated MAH.Note: The MAH may manufacture the product and may also contract the manufacturing of the product to one or more companies (organizations).
        • status
          Enumeration<Medication.MedicationStatusCodes> status
          A code to indicate if the medication is in active use.
        • totalVolume
          Quantity totalVolume
          When the specified product code does not infer a package size, this is the specific amount of drug in the product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).

    • Class org.hl7.fhir.r5.model.Medication.MedicationBatchComponent

      class MedicationBatchComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1982738755L

      • Serialized Fields

        • expirationDate
          DateTimeType expirationDate
          When this specific batch of product will expire.
        • lotNumber
          StringType lotNumber
          The assigned lot number of a batch of the specified product.

    • Class org.hl7.fhir.r5.model.Medication.MedicationIngredientComponent

      class MedicationIngredientComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -979760018L

      • Serialized Fields

        • isActive
          BooleanType isActive
          Indication of whether this ingredient affects the therapeutic action of the drug.
        • item
          CodeableReference item
          The ingredient (substance or medication) that the ingredient.strength relates to. This is represented as a concept from a code system or described in another resource (Substance or Medication).
        • strength
          DataType strength
          Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet.

    • Class org.hl7.fhir.r5.model.Medication.MedicationStatusCodesEnumFactory

      class MedicationStatusCodesEnumFactory extends Object implements Serializable

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

      class MedicationAdministration extends DomainResource implements Serializable
      serialVersionUID:
      296165909L

      • Serialized Fields

        • basedOn
          List<Reference> basedOn
          A plan that is fulfilled in whole or in part by this MedicationAdministration.
        • category
          List<CodeableConcept> category
          The type of medication administration (for example, drug classification like ATC, where meds would be administered, legal category of the medication).
        • device
          List<CodeableReference> device
          The device that is to be used for the administration of the medication (for example, PCA Pump).
        • dosage
          MedicationAdministration.MedicationAdministrationDosageComponent dosage
          Describes the medication dosage information details e.g. dose, rate, site, route, etc.
        • encounter
          Reference encounter
          The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.
        • eventHistory
          List<Reference> eventHistory
          A summary of the events of interest that have occurred, such as when the administration was verified.
        • identifier
          List<Identifier> identifier
          Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
        • isSubPotent
          BooleanType isSubPotent
          An indication that the full dose was not administered.
        • medication
          CodeableReference medication
          Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
        • note
          List<Annotation> note
          Extra information about the medication administration that is not conveyed by the other attributes.
        • occurence
          DataType occurence
          A specific date/time or interval of time during which the administration took place (or did not take place). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.
        • partOf
          List<Reference> partOf
          A larger event of which this particular event is a component or step.
        • performer
          List<MedicationAdministration.MedicationAdministrationPerformerComponent> performer
          The performer of the medication treatment. For devices this is the device that performed the administration of the medication. An IV Pump would be an example of a device that is performing the administration. Both the IV Pump and the practitioner that set the rate or bolus on the pump can be listed as performers.
        • reason
          List<CodeableReference> reason
          A code, Condition or observation that supports why the medication was administered.
        • recorded
          DateTimeType recorded
          The date the occurrence of the MedicationAdministration was first captured in the record - potentially significantly after the occurrence of the event.
        • request
          Reference request
          The original request, instruction or authority to perform the administration.
        • status
          Enumeration<MedicationAdministration.MedicationAdministrationStatusCodes> status
          Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.
        • statusReason
          List<CodeableConcept> statusReason
          A code indicating why the administration was not performed.
        • subject
          Reference subject
          The person or animal or group receiving the medication.
        • subPotentReason
          List<CodeableConcept> subPotentReason
          The reason or reasons why the full dose was not administered.
        • supportingInformation
          List<Reference> supportingInformation
          Additional information (for example, patient height and weight) that supports the administration of the medication. This attribute can be used to provide documentation of specific characteristics of the patient present at the time of administration. For example, if the dose says "give "x" if the heartrate exceeds "y"", then the heart rate can be included using this attribute.

    • Class org.hl7.fhir.r5.model.MedicationAdministration.MedicationAdministrationDosageComponent

      class MedicationAdministrationDosageComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -484090956L

      • Serialized Fields

        • dose
          Quantity dose
          The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.
        • method
          CodeableConcept method
          A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV.
        • rate
          DataType rate
          Identifies the speed with which the medication was or will be introduced into the patient. Typically, the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time, e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.
        • route
          CodeableConcept route
          A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.
        • site
          CodeableConcept site
          A coded specification of the anatomic site where the medication first entered the body. For example, "left arm".
        • text
          StringType text
          Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans. The dosage instructions should reflect the dosage of the medication that was administered.

    • Class org.hl7.fhir.r5.model.MedicationAdministration.MedicationAdministrationPerformerComponent

      class MedicationAdministrationPerformerComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1725418144L

      • Serialized Fields

        • actor
          CodeableReference actor
          Indicates who or what performed the medication administration.
        • function
          CodeableConcept function
          Distinguishes the type of involvement of the performer in the medication administration.

    • Class org.hl7.fhir.r5.model.MedicationAdministration.MedicationAdministrationStatusCodesEnumFactory

      class MedicationAdministrationStatusCodesEnumFactory extends Object implements Serializable

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

      class MedicationDispense extends DomainResource implements Serializable
      serialVersionUID:
      88138059L

      • Serialized Fields

        • authorizingPrescription
          List<Reference> authorizingPrescription
          Indicates the medication order that is being dispensed against.
        • basedOn
          List<Reference> basedOn
          A plan that is fulfilled in whole or in part by this MedicationDispense.
        • category
          List<CodeableConcept> category
          Indicates the type of medication dispense (for example, drug classification like ATC, where meds would be administered, legal category of the medication.).
        • daysSupply
          Quantity daysSupply
          The amount of medication expressed as a timing amount.
        • destination
          Reference destination
          Identification of the facility/location where the medication was/will be shipped to, as part of the dispense event.
        • dosageInstruction
          List<Dosage> dosageInstruction
          Indicates how the medication is to be used by the patient.
        • 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
          Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
        • location
          Reference location
          The principal physical location where the dispense was performed.
        • medication
          CodeableReference medication
          Identifies the medication supplied. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
        • note
          List<Annotation> note
          Extra information about the dispense that could not be conveyed in the other attributes.
        • notPerformedReason
          CodeableReference notPerformedReason
          Indicates the reason why a dispense was not performed.
        • partOf
          List<Reference> partOf
          The procedure or medication administration that triggered the dispense.
        • performer
          List<MedicationDispense.MedicationDispensePerformerComponent> performer
          Indicates who or what performed the event.
        • quantity
          Quantity quantity
          The amount of medication that has been dispensed. Includes unit of measure.
        • receiver
          List<Reference> receiver
          Identifies the person who picked up the medication or the location of where the medication was delivered. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional or a location.
        • recorded
          DateTimeType recorded
          The date (and maybe time) when the dispense activity started if whenPrepared or whenHandedOver is not populated.
        • renderedDosageInstruction
          MarkdownType renderedDosageInstruction
          The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.
        • status
          Enumeration<MedicationDispense.MedicationDispenseStatusCodes> status
          A code specifying the state of the set of dispense events.
        • statusChanged
          DateTimeType statusChanged
          The date (and maybe time) when the status of the dispense record changed.
        • subject
          Reference subject
          A link to a resource representing the person or the group to whom the medication will be given.
        • substitution
          MedicationDispense.MedicationDispenseSubstitutionComponent substitution
          Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.
        • supportingInformation
          List<Reference> supportingInformation
          Additional information that supports the medication being dispensed. For example, there may be requirements that a specific lab test has been completed prior to dispensing or the patient's weight at the time of dispensing is documented.
        • type
          CodeableConcept type
          Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
        • whenHandedOver
          DateTimeType whenHandedOver
          The time the dispensed product was provided to the patient or their representative.
        • whenPrepared
          DateTimeType whenPrepared
          The time when the dispensed product was packaged and reviewed.

    • Class org.hl7.fhir.r5.model.MedicationDispense.MedicationDispensePerformerComponent

      class MedicationDispensePerformerComponent 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 medication.
        • function
          CodeableConcept function
          Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.

    • Class org.hl7.fhir.r5.model.MedicationDispense.MedicationDispenseStatusCodesEnumFactory

      class MedicationDispenseStatusCodesEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.MedicationDispense.MedicationDispenseSubstitutionComponent

      class MedicationDispenseSubstitutionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      431402218L

      • Serialized Fields

        • reason
          List<CodeableConcept> reason
          Indicates the reason for the substitution (or lack of substitution) from what was prescribed.
        • responsibleParty
          Reference responsibleParty
          The person or organization that has primary responsibility for the substitution.
        • type
          CodeableConcept type
          A code signifying whether a different drug was dispensed from what was prescribed.
        • wasSubstituted
          BooleanType wasSubstituted
          True if the dispenser dispensed a different drug or product from what was prescribed.

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

      class MedicationKnowledge extends DomainResource implements Serializable
      serialVersionUID:
      -814493741L

    • Class org.hl7.fhir.r5.model.MedicationKnowledge.MedicationKnowledgeCostComponent

      class MedicationKnowledgeCostComponent extends BackboneElement implements Serializable
      serialVersionUID:
      747402134L

      • Serialized Fields

        • cost
          DataType cost
          The price or representation of the cost (for example, Band A, Band B or $, $$) of the medication.
        • effectiveDate
          List<Period> effectiveDate
          The date range for which the cost information of the medication is effective.
        • source
          StringType source
          The source or owner that assigns the price to the medication.
        • type
          CodeableConcept type
          The category of the cost information. For example, manufacturers' cost, patient cost, claim reimbursement cost, actual acquisition cost.

    • Class org.hl7.fhir.r5.model.MedicationKnowledge.MedicationKnowledgeDefinitionalComponent

      class MedicationKnowledgeDefinitionalComponent extends BackboneElement implements Serializable
      serialVersionUID:
      2050532775L

    • Class org.hl7.fhir.r5.model.MedicationKnowledge.MedicationKnowledgeDefinitionalDrugCharacteristicComponent

      class MedicationKnowledgeDefinitionalDrugCharacteristicComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1659186716L

      • Serialized Fields

        • type
          CodeableConcept type
          A code specifying which characteristic of the medicine is being described (for example, colour, shape, imprint).
        • value
          DataType value
          Description of the characteristic.

    • Class org.hl7.fhir.r5.model.MedicationKnowledge.MedicationKnowledgeDefinitionalIngredientComponent

      class MedicationKnowledgeDefinitionalIngredientComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1772676131L

      • Serialized Fields

        • item
          CodeableReference item
          A reference to the resource that provides information about the ingredient.
        • strength
          DataType strength
          Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet.
        • type
          CodeableConcept type
          Indication of whether this ingredient affects the therapeutic action of the drug.

    • Class org.hl7.fhir.r5.model.MedicationKnowledge.MedicationKnowledgeIndicationGuidelineComponent

      class MedicationKnowledgeIndicationGuidelineComponent extends BackboneElement implements Serializable
      serialVersionUID:
      256409722L

    • Class org.hl7.fhir.r5.model.MedicationKnowledge.MedicationKnowledgeIndicationGuidelineDosingGuidelineComponent

      class MedicationKnowledgeIndicationGuidelineDosingGuidelineComponent extends BackboneElement implements Serializable
      serialVersionUID:
      882198366L

    • Class org.hl7.fhir.r5.model.MedicationKnowledge.MedicationKnowledgeIndicationGuidelineDosingGuidelineDosageComponent

      class MedicationKnowledgeIndicationGuidelineDosingGuidelineDosageComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1578257961L

      • Serialized Fields

        • dosage
          List<Dosage> dosage
          Dosage for the medication for the specific guidelines.
        • type
          CodeableConcept type
          The type or category of dosage for a given medication (for example, prophylaxis, maintenance, therapeutic, etc.).

    • Class org.hl7.fhir.r5.model.MedicationKnowledge.MedicationKnowledgeIndicationGuidelineDosingGuidelinePatientCharacteristicComponent

      class MedicationKnowledgeIndicationGuidelineDosingGuidelinePatientCharacteristicComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1659186716L

      • Serialized Fields

        • type
          CodeableConcept type
          The categorization of the specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender).
        • value
          DataType value
          The specific characteristic (e.g. height, weight, gender, etc.).

    • Class org.hl7.fhir.r5.model.MedicationKnowledge.MedicationKnowledgeMedicineClassificationComponent

      class MedicationKnowledgeMedicineClassificationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1598220123L

      • Serialized Fields

        • classification
          List<CodeableConcept> classification
          Specific category assigned to the medication (e.g. anti-infective, anti-hypertensive, antibiotic, etc.).
        • source
          DataType source
          Either a textual source of the classification or a reference to an online source.
        • type
          CodeableConcept type
          The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification).

    • Class org.hl7.fhir.r5.model.MedicationKnowledge.MedicationKnowledgeMonitoringProgramComponent

      class MedicationKnowledgeMonitoringProgramComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -280346281L

      • Serialized Fields

        • name
          StringType name
          Name of the reviewing program.
        • type
          CodeableConcept type
          Type of program under which the medication is monitored.

    • Class org.hl7.fhir.r5.model.MedicationKnowledge.MedicationKnowledgeMonographComponent

      class MedicationKnowledgeMonographComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -197893751L

      • Serialized Fields

        • source
          Reference source
          Associated documentation about the medication.
        • type
          CodeableConcept type
          The category of documentation about the medication. (e.g. professional monograph, patient education monograph).

    • Class org.hl7.fhir.r5.model.MedicationKnowledge.MedicationKnowledgePackagingComponent

      class MedicationKnowledgePackagingComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -337249398L

    • Class org.hl7.fhir.r5.model.MedicationKnowledge.MedicationKnowledgeRegulatoryComponent

      class MedicationKnowledgeRegulatoryComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -2005823416L

    • Class org.hl7.fhir.r5.model.MedicationKnowledge.MedicationKnowledgeRegulatoryMaxDispenseComponent

      class MedicationKnowledgeRegulatoryMaxDispenseComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -441724185L

      • Serialized Fields

        • period
          Duration period
          The period that applies to the maximum number of units.
        • quantity
          Quantity quantity
          The maximum number of units of the medication that can be dispensed.

    • Class org.hl7.fhir.r5.model.MedicationKnowledge.MedicationKnowledgeRegulatorySubstitutionComponent

      class MedicationKnowledgeRegulatorySubstitutionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      396354861L

      • Serialized Fields

        • allowed
          BooleanType allowed
          Specifies if regulation allows for changes in the medication when dispensing.
        • type
          CodeableConcept type
          Specifies the type of substitution allowed.

    • Class org.hl7.fhir.r5.model.MedicationKnowledge.MedicationKnowledgeRelatedMedicationKnowledgeComponent

      class MedicationKnowledgeRelatedMedicationKnowledgeComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1687147899L

      • Serialized Fields

        • reference
          List<Reference> reference
          Associated documentation about the associated medication knowledge.
        • type
          CodeableConcept type
          The category of the associated medication knowledge reference.

    • Class org.hl7.fhir.r5.model.MedicationKnowledge.MedicationKnowledgeStatusCodesEnumFactory

      class MedicationKnowledgeStatusCodesEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.MedicationKnowledge.MedicationKnowledgeStorageGuidelineComponent

      class MedicationKnowledgeStorageGuidelineComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -304442588L

      • Serialized Fields

        • environmentalSetting
          List<MedicationKnowledge.MedicationKnowledgeStorageGuidelineEnvironmentalSettingComponent> environmentalSetting
          Describes a setting/value on the environment for the adequate storage of the medication and other substances. Environment settings may involve temperature, humidity, or exposure to light.
        • note
          List<Annotation> note
          Additional notes about the storage.
        • reference
          UriType reference
          Reference to additional information about the storage guidelines.
        • stabilityDuration
          Duration stabilityDuration
          Duration that the medication remains stable if the environmentalSetting is respected.

    • Class org.hl7.fhir.r5.model.MedicationKnowledge.MedicationKnowledgeStorageGuidelineEnvironmentalSettingComponent

      class MedicationKnowledgeStorageGuidelineEnvironmentalSettingComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1659186716L

      • Serialized Fields

        • type
          CodeableConcept type
          Identifies the category or type of setting (e.g., type of location, temperature, humidity).
        • value
          DataType value
          Value associated to the setting. E.g., 40° ? 50°F for temperature.

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

      class MedicationRequest extends DomainResource implements Serializable
      serialVersionUID:
      1013423544L

      • Serialized Fields

        • authoredOn
          DateTimeType authoredOn
          The date (and perhaps time) when the prescription was initially written or authored on.
        • basedOn
          List<Reference> basedOn
          A plan or request that is fulfilled in whole or in part by this medication request.
        • category
          List<CodeableConcept> category
          An arbitrary categorization or grouping of the medication request. It could be used for indicating where meds are intended to be administered, eg. in an inpatient setting or in a patient's home, or a legal category of the medication.
        • courseOfTherapyType
          CodeableConcept courseOfTherapyType
          The description of the overall pattern of the administration of the medication to the patient.
        • device
          List<CodeableReference> device
          The intended type of device that is to be used for the administration of the medication (for example, PCA Pump).
        • dispenseRequest
          MedicationRequest.MedicationRequestDispenseRequestComponent dispenseRequest
          Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.
        • doNotPerform
          BooleanType doNotPerform
          If true, indicates that the provider is asking for the patient to either stop taking or to not start taking the specified medication. For example, the patient is taking an existing medication and the provider is changing their medication. They want to create two seperate requests: one to stop using the current medication and another to start the new medication.
        • dosageInstruction
          List<Dosage> dosageInstruction
          Specific instructions for how the medication is to be used by the patient.
        • effectiveDosePeriod
          Period effectiveDosePeriod
          The period over which the medication is to be taken. Where there are multiple dosageInstruction lines (for example, tapering doses), this is the earliest date and the latest end date of the dosageInstructions.
        • encounter
          Reference encounter
          The Encounter during which this [x] was created or to which the creation of this record is tightly associated.
        • eventHistory
          List<Reference> eventHistory
          Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.
        • groupIdentifier
          Identifier groupIdentifier
          A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.
        • identifier
          List<Identifier> identifier
          Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
        • informationSource
          List<Reference> informationSource
          The person or organization who provided the information about this request, if the source is someone other than the requestor. This is often used when the MedicationRequest is reported by another person.
        • 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<MedicationRequest.MedicationRequestIntent> intent
          Whether the request is a proposal, plan, or an original order.
        • medication
          CodeableReference medication
          Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
        • note
          List<Annotation> note
          Extra information about the prescription that could not be conveyed by the other attributes.
        • performer
          List<Reference> performer
          The specified desired performer of the medication treatment (e.g. the performer of the medication administration). For devices, this is the device that is intended to perform the administration of the medication. An IV Pump would be an example of a device that is performing the administration. Both the IV Pump and the practitioner that set the rate or bolus on the pump can be listed as performers.
        • performerType
          CodeableConcept performerType
          Indicates the type of performer of the administration of the medication.
        • priority
          Enumeration<Enumerations.RequestPriority> priority
          Indicates how quickly the Medication Request should be addressed with respect to other requests.
        • priorPrescription
          Reference priorPrescription
          Reference to an order/prescription that is being replaced by this MedicationRequest.
        • reason
          List<CodeableReference> reason
          The reason or the indication for ordering or not ordering the medication.
        • recorder
          Reference recorder
          The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.
        • renderedDosageInstruction
          MarkdownType renderedDosageInstruction
          The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.
        • reported
          BooleanType reported
          Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.
        • requester
          Reference requester
          The individual, organization, or device that initiated the request and has responsibility for its activation.
        • status
          Enumeration<MedicationRequest.MedicationrequestStatus> status
          A code specifying the current state of the order. Generally, this will be active or completed state.
        • statusChanged
          DateTimeType statusChanged
          The date (and perhaps time) when the status was changed.
        • statusReason
          CodeableConcept statusReason
          Captures the reason for the current state of the MedicationRequest.
        • subject
          Reference subject
          The individual or group for whom the medication has been requested.
        • substitution
          MedicationRequest.MedicationRequestSubstitutionComponent substitution
          Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.
        • supportingInformation
          List<Reference> supportingInformation
          Information to support fulfilling (i.e. dispensing or administering) of the medication, for example, patient height and weight, a MedicationStatement for the patient).

    • Class org.hl7.fhir.r5.model.MedicationRequest.MedicationRequestDispenseRequestComponent

      class MedicationRequestDispenseRequestComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -916083616L

      • Serialized Fields

        • dispenseInterval
          Duration dispenseInterval
          The minimum period of time that must occur between dispenses of the medication.
        • dispenser
          Reference dispenser
          Indicates the intended performing Organization that will dispense the medication as specified by the prescriber.
        • dispenserInstruction
          List<Annotation> dispenserInstruction
          Provides additional information to the dispenser, for example, counselling to be provided to the patient.
        • doseAdministrationAid
          CodeableConcept doseAdministrationAid
          Provides information about the type of adherence packaging to be supplied for the medication dispense.
        • expectedSupplyDuration
          Duration expectedSupplyDuration
          Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last.
        • initialFill
          MedicationRequest.MedicationRequestDispenseRequestInitialFillComponent initialFill
          Indicates the quantity or duration for the first dispense of the medication.
        • numberOfRepeatsAllowed
          UnsignedIntType numberOfRepeatsAllowed
          An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication. Usage Notes: This integer does not include the original order dispense. This means that if an order indicates dispense 30 tablets plus "3 repeats", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets. A prescriber may explicitly say that zero refills are permitted after the initial dispense.
        • quantity
          Quantity quantity
          The amount that is to be dispensed for one fill.
        • validityPeriod
          Period validityPeriod
          This indicates the validity period of a prescription (stale dating the Prescription).

    • Class org.hl7.fhir.r5.model.MedicationRequest.MedicationRequestDispenseRequestInitialFillComponent

      class MedicationRequestDispenseRequestInitialFillComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1223227956L

      • Serialized Fields

        • duration
          Duration duration
          The length of time that the first dispense is expected to last.
        • quantity
          Quantity quantity
          The amount or quantity to provide as part of the first dispense.

    • Class org.hl7.fhir.r5.model.MedicationRequest.MedicationRequestIntentEnumFactory

      class MedicationRequestIntentEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.MedicationRequest.MedicationrequestStatusEnumFactory

      class MedicationrequestStatusEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.MedicationRequest.MedicationRequestSubstitutionComponent

      class MedicationRequestSubstitutionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -855005751L

      • Serialized Fields

        • allowed
          DataType allowed
          True if the prescriber allows a different drug to be dispensed from what was prescribed.
        • reason
          CodeableConcept reason
          Indicates the reason for the substitution, or why substitution must or must not be performed.

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

      class MedicationStatement extends DomainResource implements Serializable
      serialVersionUID:
      -1043616866L

      • Serialized Fields

        • adherence
          MedicationStatement.MedicationStatementAdherenceComponent adherence
          Indicates whether the medication is or is not being consumed or administered.
        • category
          List<CodeableConcept> category
          Type of medication statement (for example, drug classification like ATC, where meds would be administered, legal category of the medication.).
        • dateAsserted
          DateTimeType dateAsserted
          The date when the Medication Statement was asserted by the information source.
        • derivedFrom
          List<Reference> derivedFrom
          Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement.
        • dosage
          List<Dosage> dosage
          Indicates how the medication is/was or should be taken by the patient.
        • effective
          DataType effective
          The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.adherence element is Not Taking).
        • encounter
          Reference encounter
          The encounter that establishes the context for this MedicationStatement.
        • identifier
          List<Identifier> identifier
          Identifiers associated with this Medication Statement that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
        • informationSource
          List<Reference> informationSource
          The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g. Claim or MedicationRequest.
        • medication
          CodeableReference medication
          Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
        • note
          List<Annotation> note
          Provides extra information about the Medication Statement that is not conveyed by the other attributes.
        • partOf
          List<Reference> partOf
          A larger event of which this particular MedicationStatement is a component or step.
        • reason
          List<CodeableReference> reason
          A concept, Condition or observation that supports why the medication is being/was taken.
        • relatedClinicalInformation
          List<Reference> relatedClinicalInformation
          Link to information that is relevant to a medication statement, for example, illicit drug use, gestational age, etc.
        • renderedDosageInstruction
          MarkdownType renderedDosageInstruction
          The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.
        • status
          Enumeration<MedicationStatement.MedicationStatementStatusCodes> status
          A code representing the status of recording the medication statement.
        • subject
          Reference subject
          The person, animal or group who is/was taking the medication.

    • Class org.hl7.fhir.r5.model.MedicationStatement.MedicationStatementAdherenceComponent

      class MedicationStatementAdherenceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1479626679L

      • Serialized Fields

        • code
          CodeableConcept code
          Type of the adherence for the medication.
        • reason
          CodeableConcept reason
          Captures the reason for the current use or adherence of a medication.

    • Class org.hl7.fhir.r5.model.MedicationStatement.MedicationStatementStatusCodesEnumFactory

      class MedicationStatementStatusCodesEnumFactory extends Object implements Serializable

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

      class MedicinalProductDefinition extends DomainResource implements Serializable
      serialVersionUID:
      1105265034L

      • Serialized Fields

        • additionalMonitoringIndicator
          CodeableConcept additionalMonitoringIndicator
          Whether the Medicinal Product is subject to additional monitoring for regulatory reasons, such as heightened reporting requirements.
        • attachedDocument
          List<Reference> attachedDocument
          Additional information or supporting documentation about the medicinal product.
        • characteristic
          List<MedicinalProductDefinition.MedicinalProductDefinitionCharacteristicComponent> characteristic
          Allows the key product features to be recorded, such as "sugar free", "modified release", "parallel import".
        • classification
          List<CodeableConcept> classification
          Allows the product to be classified by various systems, commonly WHO ATC.
        • clinicalTrial
          List<Reference> clinicalTrial
          Clinical trials or studies that this product is involved in.
        • code
          List<Coding> code
          A code that this product is known by, usually within some formal terminology, perhaps assigned by a third party (i.e. not the manufacturer or regulator). Products (types of medications) tend to be known by identifiers during development and within regulatory process. However when they are prescribed they tend to be identified by codes. The same product may be have multiple codes, applied to it by multiple organizations.
        • combinedPharmaceuticalDoseForm
          CodeableConcept combinedPharmaceuticalDoseForm
          The dose form for a single part product, or combined form of a multiple part product. This is one concept that describes all the components. It does not represent the form with components physically mixed, if that might be necessary, for which see (AdministrableProductDefinition.administrableDoseForm).
        • comprisedOf
          List<Reference> comprisedOf
          Types of medicinal manufactured items and/or devices that this product consists of, such as tablets, capsule, or syringes. Used as a direct link when the item's packaging is not being recorded (see also PackagedProductDefinition.package.containedItem.item).
        • contact
          List<MedicinalProductDefinition.MedicinalProductDefinitionContactComponent> contact
          A product specific contact, person (in a role), or an organization.
        • crossReference
          List<MedicinalProductDefinition.MedicinalProductDefinitionCrossReferenceComponent> crossReference
          Reference to another product, e.g. for linking authorised to investigational product, or a virtual product.
        • description
          MarkdownType description
          General description of this product.
        • domain
          CodeableConcept domain
          If this medicine applies to human or veterinary uses.
        • identifier
          List<Identifier> identifier
          Business identifier for this product. Could be an MPID. When in development or being regulated, products are typically referenced by official identifiers, assigned by a manufacturer or regulator, and unique to a product (which, when compared to a product instance being prescribed, is actually a product type). See also MedicinalProductDefinition.code.
        • impurity
          List<CodeableReference> impurity
          Any component of the drug product which is not the chemical entity defined as the drug substance, or an excipient in the drug product. This includes process-related impurities and contaminants, product-related impurities including degradation products.
        • indication
          MarkdownType indication
          Description of indication(s) for this product, used when structured indications are not required. In cases where structured indications are required, they are captured using the ClinicalUseDefinition resource. An indication is a medical situation for which using the product is appropriate.
        • ingredient
          List<CodeableConcept> ingredient
          The ingredients of this medicinal product - when not detailed in other resources. This is only needed if the ingredients are not specified by incoming references from the Ingredient resource, or indirectly via incoming AdministrableProductDefinition, PackagedProductDefinition or ManufacturedItemDefinition references. In cases where those levels of detail are not used, the ingredients may be specified directly here as codes.
        • legalStatusOfSupply
          CodeableConcept legalStatusOfSupply
          The legal status of supply of the medicinal product as classified by the regulator.
        • marketingStatus
          List<MarketingStatus> marketingStatus
          Marketing status of the medicinal product, in contrast to marketing authorization. This refers to the product being actually 'on the market' as opposed to being allowed to be on the market (which is an authorization).
        • masterFile
          List<Reference> masterFile
          A master file for the medicinal product (e.g. Pharmacovigilance System Master File). Drug master files (DMFs) are documents submitted to regulatory agencies to provide confidential detailed information about facilities, processes or articles used in the manufacturing, processing, packaging and storing of drug products.
        • name
          List<MedicinalProductDefinition.MedicinalProductDefinitionNameComponent> name
          The product's name, including full name and possibly coded parts.
        • operation
          List<MedicinalProductDefinition.MedicinalProductDefinitionOperationComponent> operation
          A manufacturing or administrative process or step associated with (or performed on) the medicinal product.
        • packagedMedicinalProduct
          List<CodeableConcept> packagedMedicinalProduct
          Package type for the product. See also the PackagedProductDefinition resource.
        • pediatricUseIndicator
          CodeableConcept pediatricUseIndicator
          If authorised for use in children, or infants, neonates etc.
        • route
          List<CodeableConcept> route
          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. See also AdministrableProductDefinition resource. MedicinalProductDefinition.route is the same concept as AdministrableProductDefinition.routeOfAdministration.code, and they cannot be used together.
        • specialMeasures
          List<CodeableConcept> specialMeasures
          Whether the Medicinal Product is subject to special measures for regulatory reasons, such as a requirement to conduct post-authorization studies.
        • status
          CodeableConcept status
          The status within the lifecycle of this product record. A high-level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization status.
        • statusDate
          DateTimeType statusDate
          The date at which the given status became applicable.
        • type
          CodeableConcept type
          Regulatory type, e.g. Investigational or Authorized.
        • version
          StringType version
          A business identifier relating to a specific version of the product, this is commonly used to support revisions to an existing product.

    • Class org.hl7.fhir.r5.model.MedicinalProductDefinition.MedicinalProductDefinitionCharacteristicComponent

      class MedicinalProductDefinitionCharacteristicComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1659186716L

      • Serialized Fields

        • type
          CodeableConcept type
          A code expressing the type of characteristic.
        • value
          DataType value
          A value for the characteristic.text.

    • Class org.hl7.fhir.r5.model.MedicinalProductDefinition.MedicinalProductDefinitionContactComponent

      class MedicinalProductDefinitionContactComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -587616244L

      • Serialized Fields

        • contact
          Reference contact
          A product specific contact, person (in a role), or an organization.
        • type
          CodeableConcept type
          Allows the contact to be classified, for example QPPV, Pharmacovigilance Enquiry Information.

    • Class org.hl7.fhir.r5.model.MedicinalProductDefinition.MedicinalProductDefinitionCrossReferenceComponent

      class MedicinalProductDefinitionCrossReferenceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1746125578L

      • Serialized Fields

        • product
          CodeableReference product
          Reference to another product, e.g. for linking authorised to investigational product.
        • type
          CodeableConcept type
          The type of relationship, for instance branded to generic, virtual to actual product, product to development product (investigational), parallel import version.

    • Class org.hl7.fhir.r5.model.MedicinalProductDefinition.MedicinalProductDefinitionNameComponent

      class MedicinalProductDefinitionNameComponent extends BackboneElement implements Serializable
      serialVersionUID:
      890277480L

    • Class org.hl7.fhir.r5.model.MedicinalProductDefinition.MedicinalProductDefinitionNamePartComponent

      class MedicinalProductDefinitionNamePartComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1359126549L

      • Serialized Fields

        • part
          StringType part
          A fragment of a product name.
        • type
          CodeableConcept type
          Identifying type for this part of the name (e.g. strength part).

    • Class org.hl7.fhir.r5.model.MedicinalProductDefinition.MedicinalProductDefinitionNameUsageComponent

      class MedicinalProductDefinitionNameUsageComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1627157564L

      • Serialized Fields

        • country
          CodeableConcept country
          Country code for where this name applies.
        • jurisdiction
          CodeableConcept jurisdiction
          Jurisdiction code for where this name applies. A jurisdiction may be a sub- or supra-national entity (e.g. a state or a geographic region).
        • language
          CodeableConcept language
          Language code for this name.

    • Class org.hl7.fhir.r5.model.MedicinalProductDefinition.MedicinalProductDefinitionOperationComponent

      class MedicinalProductDefinitionOperationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1036054906L

      • Serialized Fields

        • confidentialityIndicator
          CodeableConcept confidentialityIndicator
          Specifies whether this particular business or manufacturing process is considered proprietary or confidential.
        • effectiveDate
          Period effectiveDate
          Date range of applicability.
        • organization
          List<Reference> organization
          The organization or establishment responsible for (or associated with) the particular process or step, examples include the manufacturer, importer, agent.
        • type
          CodeableReference type
          The type of manufacturing operation e.g. manufacturing itself, re-packaging. For the authorization of this, a RegulatedAuthorization would point to the same plan or activity referenced here.

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

      class MessageDefinition extends CanonicalResource implements Serializable
      serialVersionUID:
      1378164694L

      • Serialized Fields

        • allowedResponse
          List<MessageDefinition.MessageDefinitionAllowedResponseComponent> allowedResponse
          Indicates what types of messages may be sent as an application-level response to this message.
        • base
          CanonicalType base
          The MessageDefinition that is the basis for the contents of this resource.
        • category
          Enumeration<MessageDefinition.MessageSignificanceCategory> category
          The impact of the content of the message.
        • 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 message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the message definition was last significantly changed. 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 message definition changes.
        • description
          MarkdownType description
          A free text natural language description of the message definition from a consumer's perspective.
        • event
          DataType event
          Event code or link to the EventDefinition.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        • focus
          List<MessageDefinition.MessageDefinitionFocusComponent> focus
          Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.
        • graph
          CanonicalType graph
          Graph is Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a GraphDefinition that it controls what additional resources are to be added to the Bundle when building the message. The GraphDefinition can also specify profiles that apply to the various resources.
        • identifier
          List<Identifier> identifier
          A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
        • jurisdiction
          List<CodeableConcept> jurisdiction
          A legal or geographic region in which the message definition is intended to be used.
        • name
          StringType name
          A natural language name identifying the message definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • parent
          List<CanonicalType> parent
          Identifies a protocol or workflow that this MessageDefinition represents a step in.
        • publisher
          StringType publisher
          The name of the organization or individual responsible for the release and ongoing maintenance of the message definition.
        • purpose
          MarkdownType purpose
          Explanation of why this message definition is needed and why it has been designed as it has.
        • replaces
          List<CanonicalType> replaces
          A MessageDefinition that is superseded by this definition.
        • responseRequired
          Enumeration<MessageDefinition.MessageheaderResponseRequest> responseRequired
          Declare at a message definition level whether a response is required or only upon error or success, or never.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this message definition. Enables tracking the life-cycle of the content.
        • title
          StringType title
          A short, descriptive, user-friendly title for the message definition.
        • url
          UriType url
          The business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to server.
        • 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 message definition instances.
        • version
          StringType version
          The identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • Class org.hl7.fhir.r5.model.MessageDefinition.MessageDefinitionAllowedResponseComponent

      class MessageDefinitionAllowedResponseComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1943810550L

      • Serialized Fields

        • message
          CanonicalType message
          A reference to the message definition that must be adhered to by this supported response.
        • situation
          MarkdownType situation
          Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses).

    • Class org.hl7.fhir.r5.model.MessageDefinition.MessageDefinitionFocusComponent

      class MessageDefinitionFocusComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -68504836L

      • Serialized Fields

        • code
          CodeType code
          The kind of resource that must be the focus for this message.
        • max
          StringType max
          Identifies the maximum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.
        • min
          UnsignedIntType min
          Identifies the minimum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.
        • profile
          CanonicalType profile
          A profile that reflects constraints for the focal resource (and potentially for related resources).

    • Class org.hl7.fhir.r5.model.MessageDefinition.MessageheaderResponseRequestEnumFactory

      class MessageheaderResponseRequestEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.MessageDefinition.MessageSignificanceCategoryEnumFactory

      class MessageSignificanceCategoryEnumFactory extends Object implements Serializable

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

      class MessageHeader extends DomainResource implements Serializable
      serialVersionUID:
      2129967751L

      • Serialized Fields

        • author
          Reference author
          The logical author of the message - the personor device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.
        • definition
          CanonicalType definition
          Permanent link to the MessageDefinition for this message.
        • destination
          List<MessageHeader.MessageDestinationComponent> destination
          The destination application which the message is intended for.
        • event
          DataType event
          Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification are defined by the implementation. Alternatively a canonical uri to the EventDefinition.
        • focus
          List<Reference> focus
          The actual data of the message - a reference to the root/focus class of the event. This is allowed to be a Parameters resource.
        • reason
          CodeableConcept reason
          Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.
        • response
          MessageHeader.MessageHeaderResponseComponent response
          Information about the message that this message is a response to. Only present if this message is a response.
        • responsible
          Reference responsible
          The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.
        • sender
          Reference sender
          Identifies the sending system to allow the use of a trust relationship.
        • source
          MessageHeader.MessageSourceComponent source
          The source application from which this message originated.

    • Class org.hl7.fhir.r5.model.MessageHeader.MessageDestinationComponent

      class MessageDestinationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -274385787L

      • Serialized Fields

        • endpoint
          DataType endpoint
          Indicates where the message should be routed.
        • name
          StringType name
          Human-readable name for the target system.
        • receiver
          Reference receiver
          Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.
        • target
          Reference target
          Identifies the target end system in situations where the initial message transmission is to an intermediary system.

    • Class org.hl7.fhir.r5.model.MessageHeader.MessageHeaderResponseComponent

      class MessageHeaderResponseComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1091046778L

      • Serialized Fields

        • code
          Enumeration<MessageHeader.ResponseType> code
          Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.
        • details
          Reference details
          Full details of any issues found in the message.
        • identifier
          Identifier identifier
          The Bundle.identifier of the message to which this message is a response.

    • Class org.hl7.fhir.r5.model.MessageHeader.MessageSourceComponent

      class MessageSourceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      62264996L

      • Serialized Fields

        • contact
          ContactPoint contact
          An e-mail, phone, website or other contact point to use to resolve issues with message communications.
        • endpoint
          DataType endpoint
          Identifies the routing target to send acknowledgements to.
        • name
          StringType name
          Human-readable name for the source system.
        • software
          StringType software
          May include configuration or other information useful in debugging.
        • version
          StringType version
          Can convey versions of multiple systems in situations where a message passes through multiple hands.

    • Class org.hl7.fhir.r5.model.MessageHeader.ResponseTypeEnumFactory

      class ResponseTypeEnumFactory extends Object implements Serializable

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

      class Meta extends DataType implements Serializable
      serialVersionUID:
      -1386695622L

      • Serialized Fields

        • lastUpdated
          InstantType lastUpdated
          When the resource last changed - e.g. when the version changed.
        • profile
          List<CanonicalType> profile
          A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url).
        • security
          List<Coding> security
          Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
        • source
          UriType source
          A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
        • tag
          List<Coding> tag
          Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
        • versionId
          IdType versionId
          The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

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

      class MetadataResource extends CanonicalResource implements Serializable
      serialVersionUID:
      0L

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

      class MolecularSequence extends DomainResource implements Serializable
      serialVersionUID:
      611205496L

      • Serialized Fields

        • device
          Reference device
          The method for sequencing, for example, chip information.
        • focus
          List<Reference> focus
          The actual focus of a molecular sequence when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, child, or sibling. For example, in trio testing, the subject would be the child (proband) and the focus would be the parent.
        • formatted
          List<Attachment> formatted
          Sequence that was observed as file content. Can be an actual file contents, or referenced by a URL to an external system.
        • identifier
          List<Identifier> identifier
          A unique identifier for this particular sequence instance.
        • literal
          StringType literal
          Sequence that was observed.
        • performer
          Reference performer
          The organization or lab that should be responsible for this result.
        • relative
          List<MolecularSequence.MolecularSequenceRelativeComponent> relative
          A sequence defined relative to another sequence.
        • specimen
          Reference specimen
          Specimen used for sequencing.
        • subject
          Reference subject
          Indicates the subject this sequence is associated too.
        • type
          Enumeration<MolecularSequence.SequenceType> type
          Amino Acid Sequence/ DNA Sequence / RNA Sequence.

    • Class org.hl7.fhir.r5.model.MolecularSequence.MolecularSequenceRelativeComponent

      class MolecularSequenceRelativeComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1455983973L

      • Serialized Fields

        • coordinateSystem
          CodeableConcept coordinateSystem
          These are different ways of identifying nucleotides or amino acids within a sequence. Different databases and file types may use different systems. For detail definitions, see https://loinc.org/92822-6/ for more detail.
        • edit
          List<MolecularSequence.MolecularSequenceRelativeEditComponent> edit
          Changes in sequence from the starting sequence.
        • ordinalPosition
          IntegerType ordinalPosition
          Indicates the order in which the sequence should be considered when putting multiple 'relative' elements together.
        • sequenceRange
          Range sequenceRange
          Indicates the nucleotide range in the composed sequence when multiple 'relative' elements are used together.
        • startingSequence
          MolecularSequence.MolecularSequenceRelativeStartingSequenceComponent startingSequence
          A sequence that is used as a starting sequence to describe variants that are present in a sequence analyzed.

    • Class org.hl7.fhir.r5.model.MolecularSequence.MolecularSequenceRelativeEditComponent

      class MolecularSequenceRelativeEditComponent extends BackboneElement implements Serializable
      serialVersionUID:
      550127909L

      • Serialized Fields

        • end
          IntegerType end
          End position of the edit on the starting sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.
        • replacedSequence
          StringType replacedSequence
          Allele in the starting sequence. Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the starting sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end.
        • replacementSequence
          StringType replacementSequence
          Allele that was observed. Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the observed sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end.
        • start
          IntegerType start
          Start position of the edit on the starting sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.

    • Class org.hl7.fhir.r5.model.MolecularSequence.MolecularSequenceRelativeStartingSequenceComponent

      class MolecularSequenceRelativeStartingSequenceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      502438613L

      • Serialized Fields

        • chromosome
          CodeableConcept chromosome
          Structural unit composed of a nucleic acid molecule which controls its own replication through the interaction of specific proteins at one or more origins of replication ([SO:0000340](http://www.sequenceontology.org/browser/current_svn/term/SO:0000340)).
        • genomeAssembly
          CodeableConcept genomeAssembly
          The genome assembly used for starting sequence, e.g. GRCh38.
        • orientation
          Enumeration<MolecularSequence.OrientationType> orientation
          A relative reference to a DNA strand based on gene orientation. The strand that contains the open reading frame of the gene is the "sense" strand, and the opposite complementary strand is the "antisense" strand.
        • sequence
          DataType sequence
          The reference sequence that represents the starting sequence.
        • strand
          Enumeration<MolecularSequence.StrandType> strand
          An absolute reference to a strand. The Watson strand is the strand whose 5'-end is on the short arm of the chromosome, and the Crick strand as the one whose 5'-end is on the long arm.
        • windowEnd
          IntegerType windowEnd
          End position of the window on the starting sequence. This value should honor the rules of the coordinateSystem.
        • windowStart
          IntegerType windowStart
          Start position of the window on the starting sequence. This value should honor the rules of the coordinateSystem.

    • Class org.hl7.fhir.r5.model.MolecularSequence.OrientationTypeEnumFactory

      class OrientationTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.MolecularSequence.SequenceTypeEnumFactory

      class SequenceTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.MolecularSequence.StrandTypeEnumFactory

      class StrandTypeEnumFactory extends Object implements Serializable

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

      class MonetaryComponent extends DataType implements Serializable
      serialVersionUID:
      576423679L

    • Class org.hl7.fhir.r5.model.MonetaryComponent.PriceComponentTypeEnumFactory

      class PriceComponentTypeEnumFactory extends Object implements Serializable

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

      class Money extends DataType implements Serializable
      serialVersionUID:
      -484637938L

      • Serialized Fields

        • currency
          CodeType currency
          ISO 4217 Currency Code.
        • value
          DecimalType value
          Numerical value (with implicit precision).

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

      class MoneyQuantity extends Quantity implements Serializable
      serialVersionUID:
      1069574054L

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

      class NamingSystem extends MetadataResource implements Serializable
      serialVersionUID:
      -1403308569L

      • 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 NamingSystem.
        • 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 naming system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the naming system.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the naming system was last significantly changed. 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 naming system changes.
        • description
          MarkdownType description
          A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc.
        • editor
          List<ContactDetail> editor
          An individual or organization primarily responsible for internal coherence of the NamingSystem.
        • effectivePeriod
          Period effectivePeriod
          The period during which the NamingSystem content was or is planned to be in active use.
        • endorser
          List<ContactDetail> endorser
          An individual or organization asserted by the publisher to be responsible for officially endorsing the NamingSystem for use in some setting.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this naming system 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 naming 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 naming system is intended to be used.
        • kind
          Enumeration<NamingSystem.NamingSystemType> kind
          Indicates the purpose for the naming system - what kinds of things does it make unique?
        • 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 naming system. 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 responsible for the release and ongoing maintenance of the naming system.
        • purpose
          MarkdownType purpose
          Explanation of why this naming system is needed and why it has been designed as it has.
        • relatedArtifact
          List<RelatedArtifact> relatedArtifact
          Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.
        • responsible
          StringType responsible
          The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
        • reviewer
          List<ContactDetail> reviewer
          An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the NamingSystem.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this naming system. Enables tracking the life-cycle of the content.
        • title
          StringType title
          A short, descriptive, user-friendly title for the naming system.
        • topic
          List<CodeableConcept> topic
          Descriptions related to the content of the NamingSystem. Topics provide a high-level categorization as well as keywords for the NamingSystem that can be useful for filtering and searching.
        • type
          CodeableConcept type
          Categorizes a naming system for easier search by grouping related naming systems.
        • uniqueId
          List<NamingSystem.NamingSystemUniqueIdComponent> uniqueId
          Indicates how the system may be identified when referenced in electronic exchange.
        • url
          UriType url
          An absolute URI that is used to identify this naming 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 an authoritative instance of this naming system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the naming system is stored on different servers.
        • usage
          StringType usage
          Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.
        • useContext
          List<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 naming system instances.
        • version
          StringType version
          The identifier that is used to identify this version of the naming system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the naming 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which NamingSystem is more current.

    • Class org.hl7.fhir.r5.model.NamingSystem.NamingSystemIdentifierTypeEnumFactory

      class NamingSystemIdentifierTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.NamingSystem.NamingSystemTypeEnumFactory

      class NamingSystemTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.NamingSystem.NamingSystemUniqueIdComponent

      class NamingSystemUniqueIdComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -166953751L

      • Serialized Fields

        • authoritative
          BooleanType authoritative
          Indicates whether this identifier ie endorsed by the official owner of the associated naming system.
        • comment
          StringType comment
          Notes about the past or intended usage of this identifier.
        • period
          Period period
          Identifies the period of time over which this identifier is considered appropriate to refer to the naming system. Outside of this window, the identifier might be non-deterministic.
        • preferred
          BooleanType preferred
          Indicates whether this identifier is the "preferred" identifier of this type.
        • type
          Enumeration<NamingSystem.NamingSystemIdentifierType> type
          Identifies the unique identifier scheme used for this particular identifier.
        • value
          StringType value
          The string that should be sent over the wire to identify the code system or identifier system.

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

      class Narrative extends BaseNarrative implements Serializable
      serialVersionUID:
      1463852859L

      • Serialized Fields

        • div
          org.hl7.fhir.utilities.xhtml.XhtmlNode div
          The actual narrative content, a stripped down version of XHTML.
        • status
          Enumeration<Narrative.NarrativeStatus> status
          The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

    • Class org.hl7.fhir.r5.model.Narrative.NarrativeStatusEnumFactory

      class NarrativeStatusEnumFactory extends Object implements Serializable

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

      class NutritionIntake extends DomainResource implements Serializable
      serialVersionUID:
      890692162L

      • Serialized Fields

        • basedOn
          List<Reference> basedOn
          A plan, proposal or order that is fulfilled in whole or in part by this event.
        • code
          CodeableConcept code
          Overall type of nutrition intake.
        • consumedItem
          List<NutritionIntake.NutritionIntakeConsumedItemComponent> consumedItem
          What food or fluid product or item was consumed.
        • derivedFrom
          List<Reference> derivedFrom
          Allows linking the NutritionIntake to the underlying NutritionOrder, or to other information, such as AllergyIntolerance, that supports or is used to derive the NutritionIntake.
        • encounter
          Reference encounter
          The encounter that establishes the context for this NutritionIntake.
        • identifier
          List<Identifier> identifier
          Identifiers associated with this Nutrition Intake that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
        • ingredientLabel
          List<NutritionIntake.NutritionIntakeIngredientLabelComponent> ingredientLabel
          Total nutrient amounts for the whole meal, product, serving, etc.
        • instantiatesCanonical
          List<CanonicalType> instantiatesCanonical
          Instantiates FHIR protocol or definition.
        • instantiatesUri
          List<UriType> instantiatesUri
          Instantiates external protocol or definition.
        • location
          Reference location
          Where the intake occurred.
        • note
          List<Annotation> note
          Provides extra information about the Nutrition Intake that is not conveyed by the other attributes.
        • occurrence
          DataType occurrence
          The interval of time during which it is being asserted that the patient is/was consuming the food or fluid.
        • partOf
          List<Reference> partOf
          A larger event of which this particular event is a component or step.
        • performer
          List<NutritionIntake.NutritionIntakePerformerComponent> performer
          Who performed the intake and how they were involved.
        • reason
          List<CodeableReference> reason
          A reason, Condition or observation for why the food or fluid is /was consumed.
        • recorded
          DateTimeType recorded
          The date when the Nutrition Intake was asserted by the information source.
        • reported
          DataType reported
          The person or organization that provided the information about the consumption of this food or fluid. Note: Use derivedFrom when a NutritionIntake is derived from other resources.
        • status
          Enumeration<Enumerations.EventStatus> status
          A code representing the patient or other source's judgment about the state of the intake that this assertion is about. Generally, this will be active or completed.
        • statusReason
          List<CodeableConcept> statusReason
          Captures the reason for the current state of the NutritionIntake.
        • subject
          Reference subject
          The person, animal or group who is/was consuming the food or fluid.

    • Class org.hl7.fhir.r5.model.NutritionIntake.NutritionIntakeConsumedItemComponent

      class NutritionIntakeConsumedItemComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1625538068L

      • Serialized Fields

        • amount
          Quantity amount
          Quantity of the specified food.
        • notConsumed
          BooleanType notConsumed
          Indicator when a patient is in a setting where it is helpful to know if food was not consumed, such as it was refused, held (as in tube feedings), or otherwise not provided. If a consumption is being recorded from an app, such as MyFitnessPal, this indicator will likely not be used.
        • notConsumedReason
          CodeableConcept notConsumedReason
          Document the reason the food or fluid was not consumed, such as refused, held, etc.
        • nutritionProduct
          CodeableReference nutritionProduct
          Identifies the food or fluid product that was consumed. This is potentially a link to a resource representing the details of the food product (TBD) or a simple attribute carrying a code that identifies the food from a known list of foods.
        • rate
          Quantity rate
          Rate at which enteral feeding was administered.
        • schedule
          Timing schedule
          Scheduled frequency of consumption.
        • type
          CodeableConcept type
          Indicates what a category of item that was consumed: e.g., food, fluid, enteral, etc.

    • Class org.hl7.fhir.r5.model.NutritionIntake.NutritionIntakeIngredientLabelComponent

      class NutritionIntakeIngredientLabelComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -193123424L

      • Serialized Fields

        • amount
          Quantity amount
          Total amount of nutrient consumed.
        • nutrient
          CodeableReference nutrient
          Total nutrient consumed. This could be a macronutrient (protein, fat, carbohydrate), or a vitamin and mineral.

    • Class org.hl7.fhir.r5.model.NutritionIntake.NutritionIntakePerformerComponent

      class NutritionIntakePerformerComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -576943815L

      • Serialized Fields

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

      class NutritionOrder extends DomainResource implements Serializable
      serialVersionUID:
      -659986813L

      • Serialized Fields

        • allergyIntolerance
          List<Reference> allergyIntolerance
          A link to a record of allergies or intolerances which should be included in the nutrition order.
        • basedOn
          List<Reference> basedOn
          A plan or request that is fulfilled in whole or in part by this nutrition order.
        • dateTime
          DateTimeType dateTime
          The date and time that this nutrition order was requested.
        • encounter
          Reference encounter
          An encounter that provides additional information about the healthcare context in which this request is made.
        • enteralFormula
          NutritionOrder.NutritionOrderEnteralFormulaComponent enteralFormula
          Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.
        • excludeFoodModifier
          List<CodeableConcept> excludeFoodModifier
          This modifier is used to convey Order-specific modifier about the type of oral food or oral fluids that should not be given. These can be derived from patient allergies, intolerances, or preferences such as No Red Meat, No Soy or No Wheat or Gluten-Free. While it should not be necessary to repeat allergy or intolerance information captured in the referenced AllergyIntolerance resource in the excludeFoodModifier, this element may be used to convey additional specificity related to foods that should be eliminated from the patient?s diet for any reason. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.
        • foodPreferenceModifier
          List<CodeableConcept> foodPreferenceModifier
          This modifier is used to convey order-specific modifiers about the type of food that should be given. These can be derived from patient allergies, intolerances, or preferences such as Halal, Vegan or Kosher. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.
        • groupIdentifier
          Identifier groupIdentifier
          A shared identifier common to all nutrition orders that were authorized more or less simultaneously by a single author, representing the composite or group identifier.
        • identifier
          List<Identifier> identifier
          Identifiers assigned to this order by the order sender or by the order receiver.
        • instantiates
          List<UriType> instantiates
          The URL pointing to a protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.
        • instantiatesCanonical
          List<CanonicalType> instantiatesCanonical
          The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.
        • instantiatesUri
          List<UriType> instantiatesUri
          The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.
        • intent
          Enumeration<Enumerations.RequestIntent> intent
          Indicates the level of authority/intentionality associated with the NutrionOrder and where the request fits into the workflow chain.
        • note
          List<Annotation> note
          Comments made about the nutrition order by the requester, performer, subject or other participants.
        • oralDiet
          NutritionOrder.NutritionOrderOralDietComponent oralDiet
          Diet given orally in contrast to enteral (tube) feeding.
        • orderer
          Reference orderer
          The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.
        • outsideFoodAllowed
          BooleanType outsideFoodAllowed
          This modifier is used to convey whether a food item is allowed to be brought in by the patient and/or family. If set to true, indicates that the receiving system does not need to supply the food item.
        • performer
          List<CodeableReference> performer
          The specified desired performer of the nutrition order.
        • priority
          Enumeration<Enumerations.RequestPriority> priority
          Indicates how quickly the Nutrition Order should be addressed with respect to other requests.
        • status
          Enumeration<Enumerations.RequestStatus> status
          The workflow status of the nutrition order/request.
        • subject
          Reference subject
          The person or set of individuals who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.
        • supplement
          List<NutritionOrder.NutritionOrderSupplementComponent> supplement
          Oral nutritional products given in order to add further nutritional value to the patient's diet.
        • supportingInformation
          List<Reference> supportingInformation
          Information to support fulfilling (i.e. dispensing or administering) of the nutrition, for example, patient height and weight).

    • Class org.hl7.fhir.r5.model.NutritionOrder.EnteralFormulaScheduleComponent

      class EnteralFormulaScheduleComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1051458478L

      • Serialized Fields

        • asNeeded
          BooleanType asNeeded
          Indicates whether the enteral formula is only taken when needed within a specific dosing schedule.
        • asNeededFor
          CodeableConcept asNeededFor
          Indicates whether the enteral formula is only taken based on a precondition for taking the enteral formula.
        • timing
          List<Timing> timing
          The time period and frequency at which the enteral formula should be given. The enteral formula should be given for the combination of all schedules if more than one schedule is present.

    • Class org.hl7.fhir.r5.model.NutritionOrder.NutritionOrderEnteralFormulaAdditiveComponent

      class NutritionOrderEnteralFormulaAdditiveComponent extends BackboneElement implements Serializable
      serialVersionUID:
      2072791035L

      • Serialized Fields

        • productName
          StringType productName
          The product or brand name of the type of modular component to be added to the formula.
        • quantity
          Quantity quantity
          The amount of additive to be given in addition or to be mixed in with the base formula.
        • type
          CodeableReference type
          Indicates the type of modular component such as protein, carbohydrate, fat or fiber to be provided in addition to or mixed with the base formula.

    • Class org.hl7.fhir.r5.model.NutritionOrder.NutritionOrderEnteralFormulaAdministrationComponent

      class NutritionOrderEnteralFormulaAdministrationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      42374218L

      • Serialized Fields

        • quantity
          Quantity quantity
          The volume of formula to provide to the patient per the specified administration schedule.
        • rate
          DataType rate
          The rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule.
        • schedule
          NutritionOrder.EnteralFormulaScheduleComponent schedule
          Schedule information for an enteral formula.

    • Class org.hl7.fhir.r5.model.NutritionOrder.NutritionOrderEnteralFormulaComponent

      class NutritionOrderEnteralFormulaComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -694080614L

      • Serialized Fields

        • additive
          List<NutritionOrder.NutritionOrderEnteralFormulaAdditiveComponent> additive
          Indicates modular components to be provided in addition or mixed with the base formula.
        • administration
          List<NutritionOrder.NutritionOrderEnteralFormulaAdministrationComponent> administration
          Formula administration instructions as structured data. This repeating structure allows for changing the administration rate or volume over time for both bolus and continuous feeding. An example of this would be an instruction to increase the rate of continuous feeding every 2 hours.
        • administrationInstruction
          MarkdownType administrationInstruction
          Free text formula administration, feeding instructions or additional instructions or information.
        • baseFormulaProductName
          StringType baseFormulaProductName
          The product or brand name of the enteral or infant formula product such as "ACME Adult Standard Formula".
        • baseFormulaType
          CodeableReference baseFormulaType
          The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.
        • caloricDensity
          Quantity caloricDensity
          The amount of energy (calories) that the formula should provide per specified volume, typically per mL or fluid oz. For example, an infant may require a formula that provides 24 calories per fluid ounce or an adult may require an enteral formula that provides 1.5 calorie/mL.
        • deliveryDevice
          List<CodeableReference> deliveryDevice
          The intended type of device that is to be used for the administration of the enteral formula.
        • maxVolumeToDeliver
          Quantity maxVolumeToDeliver
          The maximum total quantity of formula that may be administered to a subject over the period of time, e.g. 1440 mL over 24 hours.
        • routeOfAdministration
          CodeableConcept routeOfAdministration
          The route or physiological path of administration into the patient's gastrointestinal tract for purposes of providing the formula feeding, e.g. nasogastric tube.

    • Class org.hl7.fhir.r5.model.NutritionOrder.NutritionOrderOralDietComponent

      class NutritionOrderOralDietComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1779061880L

    • Class org.hl7.fhir.r5.model.NutritionOrder.NutritionOrderOralDietNutrientComponent

      class NutritionOrderOralDietNutrientComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1042462093L

      • Serialized Fields

        • amount
          Quantity amount
          The quantity of the specified nutrient to include in diet.
        • modifier
          CodeableConcept modifier
          The nutrient that is being modified such as carbohydrate or sodium.

    • Class org.hl7.fhir.r5.model.NutritionOrder.NutritionOrderOralDietTextureComponent

      class NutritionOrderOralDietTextureComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -56402817L

      • Serialized Fields

        • foodType
          CodeableConcept foodType
          The food type(s) (e.g. meats, all foods) that the texture modification applies to. This could be all foods types.
        • modifier
          CodeableConcept modifier
          Any texture modifications (for solid foods) that should be made, e.g. easy to chew, chopped, ground, and pureed.

    • Class org.hl7.fhir.r5.model.NutritionOrder.NutritionOrderSupplementComponent

      class NutritionOrderSupplementComponent extends BackboneElement implements Serializable
      serialVersionUID:
      648731928L

      • Serialized Fields

        • instruction
          StringType instruction
          Free text or additional instructions or information pertaining to the oral supplement.
        • productName
          StringType productName
          The product or brand name of the nutritional supplement such as "Acme Protein Shake".
        • quantity
          Quantity quantity
          The amount of the nutritional supplement to be given.
        • schedule
          NutritionOrder.SupplementScheduleComponent schedule
          Schedule information for a supplement.
        • type
          CodeableReference type
          The kind of nutritional supplement product required such as a high protein or pediatric clear liquid supplement.

    • Class org.hl7.fhir.r5.model.NutritionOrder.OralDietScheduleComponent

      class OralDietScheduleComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1051458478L

      • Serialized Fields

        • asNeeded
          BooleanType asNeeded
          Indicates whether the product is only taken when needed within a specific dosing schedule.
        • asNeededFor
          CodeableConcept asNeededFor
          Indicates whether the product is only taken based on a precondition for taking the product.
        • timing
          List<Timing> timing
          The time period and frequency at which the diet should be given. The diet should be given for the combination of all schedules if more than one schedule is present.

    • Class org.hl7.fhir.r5.model.NutritionOrder.SupplementScheduleComponent

      class SupplementScheduleComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1051458478L

      • Serialized Fields

        • asNeeded
          BooleanType asNeeded
          Indicates whether the supplement is only taken when needed within a specific dosing schedule.
        • asNeededFor
          CodeableConcept asNeededFor
          Indicates whether the supplement is only taken based on a precondition for taking the supplement.
        • timing
          List<Timing> timing
          The time period and frequency at which the supplement should be given. The supplement should be given for the combination of all schedules if more than one schedule is present.

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

      class NutritionProduct extends DomainResource implements Serializable
      serialVersionUID:
      182320595L

    • Class org.hl7.fhir.r5.model.NutritionProduct.NutritionProductCharacteristicComponent

      class NutritionProductCharacteristicComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1659186716L

      • Serialized Fields

        • type
          CodeableConcept type
          A code specifying which characteristic of the product is being described (for example, colour, shape).
        • value
          DataType value
          The actual characteristic value corresponding to the type.

    • Class org.hl7.fhir.r5.model.NutritionProduct.NutritionProductIngredientComponent

      class NutritionProductIngredientComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -776277304L

      • Serialized Fields

        • amount
          List<Ratio> amount
          The amount of ingredient that is in the product.
        • item
          CodeableReference item
          The ingredient contained in the product.

    • Class org.hl7.fhir.r5.model.NutritionProduct.NutritionProductInstanceComponent

      class NutritionProductInstanceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -954985011L

      • Serialized Fields

        • biologicalSourceEvent
          Identifier biologicalSourceEvent
          An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled.
        • expiry
          DateTimeType expiry
          The time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed.
        • identifier
          List<Identifier> identifier
          The identifier for the physical instance, typically a serial number or manufacturer number.
        • lotNumber
          StringType lotNumber
          The identification of the batch or lot of the product.
        • name
          StringType name
          The name for the specific product.
        • quantity
          Quantity quantity
          The amount of items or instances that the resource considers, for instance when referring to 2 identical units together.
        • useBy
          DateTimeType useBy
          The time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed.

    • Class org.hl7.fhir.r5.model.NutritionProduct.NutritionProductNutrientComponent

      class NutritionProductNutrientComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -776277304L

      • Serialized Fields

        • amount
          List<Ratio> amount
          The amount of nutrient expressed in one or more units: X per pack / per serving / per dose.
        • item
          CodeableReference item
          The (relevant) nutrients in the product.

    • Class org.hl7.fhir.r5.model.NutritionProduct.NutritionProductStatusEnumFactory

      class NutritionProductStatusEnumFactory extends Object implements Serializable

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

      class Observation extends DomainResource implements Serializable
      serialVersionUID:
      -44103660L

      • Serialized Fields

        • basedOn
          List<Reference> basedOn
          A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
        • bodySite
          CodeableConcept bodySite
          Indicates the site on the subject's body where the observation was made (i.e. the target site).
        • bodyStructure
          Reference bodyStructure
          Indicates the body structure on the subject's body where the observation was made (i.e. the target site).
        • category
          List<CodeableConcept> category
          A code that classifies the general type of observation being made.
        • code
          CodeableConcept code
          Describes what was observed. Sometimes this is called the observation "name".
        • component
          List<Observation.ObservationComponentComponent> component
          Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.
        • dataAbsentReason
          CodeableConcept dataAbsentReason
          Provides a reason why the expected value in the element Observation.value[x] is missing.
        • derivedFrom
          List<Reference> derivedFrom
          The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
        • device
          Reference device
          A reference to the device that generates the measurements or the device settings for the device.
        • effective
          DataType effective
          The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
        • encounter
          Reference encounter
          The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
        • focus
          List<Reference> focus
          The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
        • hasMember
          List<Reference> hasMember
          This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.
        • identifier
          List<Identifier> identifier
          A unique identifier assigned to this observation.
        • instantiates
          DataType instantiates
          The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.
        • interpretation
          List<CodeableConcept> interpretation
          A categorical assessment of an observation value. For example, high, low, normal.
        • issued
          InstantType issued
          The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.
        • method
          CodeableConcept method
          Indicates the mechanism used to perform the observation.
        • note
          List<Annotation> note
          Comments about the observation or the results.
        • partOf
          List<Reference> partOf
          A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
        • performer
          List<Reference> performer
          Who was responsible for asserting the observed value as "true".
        • referenceRange
          List<Observation.ObservationReferenceRangeComponent> referenceRange
          Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.
        • specimen
          Reference specimen
          The specimen that was used when this observation was made.
        • status
          Enumeration<Enumerations.ObservationStatus> status
          The status of the result value.
        • subject
          Reference subject
          The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation.
        • triggeredBy
          List<Observation.ObservationTriggeredByComponent> triggeredBy
          Identifies the observation(s) that triggered the performance of this observation.
        • value
          DataType value
          The information determined as a result of making the observation, if the information has a simple value.

    • Class org.hl7.fhir.r5.model.Observation.ObservationComponentComponent

      class ObservationComponentComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1771757751L

      • Serialized Fields

        • code
          CodeableConcept code
          Describes what was observed. Sometimes this is called the observation "code".
        • dataAbsentReason
          CodeableConcept dataAbsentReason
          Provides a reason why the expected value in the element Observation.component.value[x] is missing.
        • interpretation
          List<CodeableConcept> interpretation
          A categorical assessment of an observation value. For example, high, low, normal.
        • referenceRange
          List<Observation.ObservationReferenceRangeComponent> referenceRange
          Guidance on how to interpret the value by comparison to a normal or recommended range.
        • value
          DataType value
          The information determined as a result of making the observation, if the information has a simple value.

    • Class org.hl7.fhir.r5.model.Observation.ObservationReferenceRangeComponent

      class ObservationReferenceRangeComponent extends BackboneElement implements Serializable
      serialVersionUID:
      470232080L

      • Serialized Fields

        • age
          Range age
          The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.
        • appliesTo
          List<CodeableConcept> appliesTo
          Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.
        • high
          Quantity high
          The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - invalid input: '<'=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).
        • low
          Quantity low
          The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - invalid input: '<'=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is invalid input: '<'=2.3).
        • normalValue
          CodeableConcept normalValue
          The value of the normal value of the reference range.
        • text
          MarkdownType text
          Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".
        • type
          CodeableConcept type
          Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

    • Class org.hl7.fhir.r5.model.Observation.ObservationTriggeredByComponent

      class ObservationTriggeredByComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -737822241L

      • Serialized Fields

        • observation
          Reference observation
          Reference to the triggering observation.
        • reason
          StringType reason
          Provides the reason why this observation was performed as a result of the observation(s) referenced.
        • type
          Enumeration<Observation.TriggeredBytype> type
          The type of trigger. Reflex | Repeat | Re-run.

    • Class org.hl7.fhir.r5.model.Observation.TriggeredBytypeEnumFactory

      class TriggeredBytypeEnumFactory extends Object implements Serializable

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

      class ObservationDefinition extends DomainResource implements Serializable
      serialVersionUID:
      -415480292L

      • Serialized Fields

        • approvalDate
          DateType approvalDate
          The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.
        • bodySite
          CodeableConcept bodySite
          The site on the subject's body where the observation is to be made.
        • category
          List<CodeableConcept> category
          A code that classifies the general type of observation.
        • code
          CodeableConcept code
          Describes what will be observed. Sometimes this is called the observation "name".
        • component
          List<ObservationDefinition.ObservationDefinitionComponentComponent> component
          Some observations have multiple component observations, expressed as separate code value pairs.
        • contact
          List<ContactDetail> contact
          Contact details to assist a user in finding and communicating with the publisher.
        • copyright
          MarkdownType copyright
          Copyright statement relating to the ObservationDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the ObservationDefinition.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the ObservationDefinition was last significantly changed. 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 ObservationDefinition changes.
        • derivedFromCanonical
          List<CanonicalType> derivedFromCanonical
          The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definition.
        • derivedFromUri
          List<UriType> derivedFromUri
          The URL pointing to an externally-defined observation definition, guideline or other definition that is adhered to in whole or in part by this definition.
        • description
          MarkdownType description
          A free text natural language description of the ObservationDefinition from the consumer's perspective.
        • device
          List<Reference> device
          The measurement model of device or actual device used to produce observations of this type.
        • effectivePeriod
          Period effectivePeriod
          The period during which the ObservationDefinition content was or is planned to be effective.
        • experimental
          BooleanType experimental
          A flag to indicate that this ObservationDefinition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
        • hasMember
          List<Reference> hasMember
          This ObservationDefinition defines a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.
        • identifier
          Identifier identifier
          Business identifiers assigned to this ObservationDefinition. by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.
        • jurisdiction
          List<CodeableConcept> jurisdiction
          A jurisdiction in which the ObservationDefinition is intended to be used.
        • lastReviewDate
          DateType lastReviewDate
          The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.
        • method
          CodeableConcept method
          The method or technique used to perform the observation.
        • multipleResultsAllowed
          BooleanType multipleResultsAllowed
          Multiple results allowed for observations conforming to this ObservationDefinition.
        • name
          StringType name
          A natural language name identifying the ObservationDefinition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • performerType
          CodeableConcept performerType
          The type of individual/organization/device that is expected to act upon instances of this definition.
        • permittedDataType
          List<Enumeration<ObservationDefinition.ObservationDataType>> permittedDataType
          The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.
        • permittedUnit
          List<Coding> permittedUnit
          Units allowed for the valueQuantity element in the instance observations conforming to this ObservationDefinition.
        • preferredReportName
          StringType preferredReportName
          The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.
        • publisher
          StringType publisher
          Helps establish the "authority/credibility" of the ObservationDefinition. May also allow for contact.
        • purpose
          MarkdownType purpose
          Explains why this ObservationDefinition is needed and why it has been designed as it has.
        • qualifiedValue
          List<ObservationDefinition.ObservationDefinitionQualifiedValueComponent> qualifiedValue
          A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations.
        • specimen
          List<Reference> specimen
          The kind of specimen that this type of observation is produced on.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The current state of the ObservationDefinition.
        • subject
          List<CodeableConcept> subject
          A code that describes the intended kind of subject of Observation instances conforming to this ObservationDefinition.
        • title
          StringType title
          A short, descriptive, user-friendly title for the ObservationDefinition.
        • url
          UriType url
          An absolute URL that is used to identify this ObservationDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this ObservationDefinition is (or will be) published. The URL SHOULD include the major version of the ObservationDefinition. For more information see Technical and Business Versions.
        • 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 ObservationDefinition instances.
        • version
          StringType version
          The identifier that is used to identify this version of the ObservationDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the ObservationDefinition 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 are orderable.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • Class org.hl7.fhir.r5.model.ObservationDefinition.ObservationDataTypeEnumFactory

      class ObservationDataTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.ObservationDefinition.ObservationDefinitionComponentComponent

      class ObservationDefinitionComponentComponent extends BackboneElement implements Serializable
      serialVersionUID:
      2106051085L

    • Class org.hl7.fhir.r5.model.ObservationDefinition.ObservationDefinitionQualifiedValueComponent

      class ObservationDefinitionQualifiedValueComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -538666361L

      • Serialized Fields

        • abnormalCodedValueSet
          CanonicalType abnormalCodedValueSet
          The set of abnormal coded results for qualitative observations that match the criteria of this set of qualified values.
        • age
          Range age
          The age range this set of qualified values applies to.
        • appliesTo
          List<CodeableConcept> appliesTo
          The target population this set of qualified values applies to.
        • condition
          StringType condition
          Text based condition for which the the set of qualified values is valid.
        • context
          CodeableConcept context
          A concept defining the context for this set of qualified values.
        • criticalCodedValueSet
          CanonicalType criticalCodedValueSet
          The set of critical coded results for qualitative observations that match the criteria of this set of qualified values.
        • gender
          Enumeration<Enumerations.AdministrativeGender> gender
          The gender this set of qualified values applies to.
        • gestationalAge
          Range gestationalAge
          The gestational age this set of qualified values applies to.
        • normalCodedValueSet
          CanonicalType normalCodedValueSet
          The set of normal coded results for qualitative observations that match the criteria of this set of qualified values.
        • range
          Range range
          The range of values defined for continuous or ordinal observations that match the criteria of this set of qualified values.
        • rangeCategory
          Enumeration<ObservationDefinition.ObservationRangeCategory> rangeCategory
          The category of range of values for continuous or ordinal observations that match the criteria of this set of qualified values.
        • validCodedValueSet
          CanonicalType validCodedValueSet
          The set of valid coded results for qualitative observations that match the criteria of this set of qualified values.

    • Class org.hl7.fhir.r5.model.ObservationDefinition.ObservationRangeCategoryEnumFactory

      class ObservationRangeCategoryEnumFactory extends Object implements Serializable

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

      class OidType extends UriType implements Externalizable
      serialVersionUID:
      3L

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

      class OperationDefinition extends CanonicalResource implements Serializable
      serialVersionUID:
      -1811668120L

      • Serialized Fields

        • affectsState
          BooleanType affectsState
          Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.
        • base
          CanonicalType base
          Indicates that this operation definition is a constraining profile on the base.
        • code
          CodeType code
          The label that is recommended to be used in the URL for this operation. In some cases, servers may need to use a different CapabilityStatement operation.name to differentiate between multiple SearchParameters that happen to have the same code.
        • comment
          MarkdownType comment
          Additional information about how to use this operation or named query.
        • 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 operation definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the operation definition.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the operation definition was last significantly changed. 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 operation definition changes.
        • description
          MarkdownType description
          A free text natural language description of the operation definition from a consumer's perspective.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage.
        • identifier
          List<Identifier> identifier
          A formal identifier that is used to identify this implementation guide when it is represented in other formats, or referenced in a specification, model, design or an instance.
        • inputProfile
          CanonicalType inputProfile
          Additional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole.
        • instance
          BooleanType instance
          Indicates whether this operation can be invoked on a particular instance of one of the given types.
        • jurisdiction
          List<CodeableConcept> jurisdiction
          A legal or geographic region in which the operation definition is intended to be used.
        • kind
          Enumeration<OperationDefinition.OperationKind> kind
          Whether this is an operation or a named query.
        • name
          StringType name
          A natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • outputProfile
          CanonicalType outputProfile
          Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.
        • overload
          List<OperationDefinition.OperationDefinitionOverloadComponent> overload
          Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.
        • parameter
          List<OperationDefinition.OperationDefinitionParameterComponent> parameter
          The parameters for the operation/query.
        • publisher
          StringType publisher
          The name of the organization or individual responsible for the release and ongoing maintenance of the operation definition.
        • purpose
          MarkdownType purpose
          Explanation of why this operation definition is needed and why it has been designed as it has.
        • resource
          List<Enumeration<Enumerations.VersionIndependentResourceTypesAll>> resource
          The types on which this operation can be executed.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The current state of this operation definition.
        • system
          BooleanType system
          Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).
        • title
          StringType title
          A short, descriptive, user-friendly title for the operation definition.
        • type
          BooleanType type
          Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).
        • url
          UriType url
          An absolute URI that is used to identify this operation 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 an authoritative instance of this operation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the operation 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 operation definition.
        • version
          StringType version
          The identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • Class org.hl7.fhir.r5.model.OperationDefinition.OperationDefinitionOverloadComponent

      class OperationDefinitionOverloadComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -907948545L

      • Serialized Fields

        • comment
          StringType comment
          Comments to go on overload.
        • parameterName
          List<StringType> parameterName
          Name of parameter to include in overload.

    • Class org.hl7.fhir.r5.model.OperationDefinition.OperationDefinitionParameterBindingComponent

      class OperationDefinitionParameterBindingComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -2048653907L

      • Serialized Fields

        • strength
          Enumeration<Enumerations.BindingStrength> strength
          Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.
        • valueSet
          CanonicalType valueSet
          Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.

    • Class org.hl7.fhir.r5.model.OperationDefinition.OperationDefinitionParameterComponent

      class OperationDefinitionParameterComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -395202201L

    • Class org.hl7.fhir.r5.model.OperationDefinition.OperationDefinitionParameterReferencedFromComponent

      class OperationDefinitionParameterReferencedFromComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -104239783L

      • Serialized Fields

        • source
          StringType source
          The name of the parameter or dot-separated path of parameter names pointing to the resource parameter that is expected to contain a reference to this resource.
        • sourceId
          StringType sourceId
          The id of the element in the referencing resource that is expected to resolve to this resource.

    • Class org.hl7.fhir.r5.model.OperationDefinition.OperationKindEnumFactory

      class OperationKindEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.OperationDefinition.OperationParameterScopeEnumFactory

      class OperationParameterScopeEnumFactory extends Object implements Serializable

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

      class OperationOutcome extends DomainResource implements Serializable
      serialVersionUID:
      -152150052L

    • Class org.hl7.fhir.r5.model.OperationOutcome.IssueSeverityEnumFactory

      class IssueSeverityEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.OperationOutcome.IssueTypeEnumFactory

      class IssueTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.OperationOutcome.OperationOutcomeIssueComponent

      class OperationOutcomeIssueComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1681095438L

      • Serialized Fields

        • code
          Enumeration<OperationOutcome.IssueType> code
          Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.
        • details
          CodeableConcept details
          Additional details about the error. This may be a text description of the error or a system code that identifies the error.
        • diagnostics
          StringType diagnostics
          Additional diagnostic information about the issue.
        • expression
          List<StringType> expression
          A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.
        • location
          List<StringType> location
          This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse. For resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be "http." + the parameter name.
        • severity
          Enumeration<OperationOutcome.IssueSeverity> severity
          Indicates whether the issue indicates a variation from successful processing.

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

      class OrderedDistribution extends BackboneType implements Serializable
      serialVersionUID:
      -1559333328L

    • Class org.hl7.fhir.r5.model.OrderedDistribution.OrderedDistributionIntervalComponent

      class OrderedDistributionIntervalComponent extends Element implements Serializable
      serialVersionUID:
      1714817635L

      • Serialized Fields

        • intervalStatistic
          List<Statistic> intervalStatistic
          Values and parameters for a single statistic related to the interval.
        • rankOrder
          IntegerType rankOrder
          Relative order of interval.

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

      class Organization extends DomainResource implements Serializable
      serialVersionUID:
      1270045104L

      • Serialized Fields

        • active
          BooleanType active
          Whether the organization's record is still in active use.
        • alias
          List<StringType> alias
          A list of alternate names that the organization is known as, or was known as in the past.
        • contact
          List<ExtendedContactDetail> contact
          The contact details of communication devices available relevant to the specific Organization. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.
        • description
          MarkdownType description
          Description of the organization, which helps provide additional general context on the organization to ensure that the correct organization is selected.
        • endpoint
          List<Reference> endpoint
          Technical endpoints providing access to services operated for the organization.
        • identifier
          List<Identifier> identifier
          Identifier for the organization that is used to identify the organization across multiple disparate systems.
        • name
          StringType name
          A name associated with the organization.
        • partOf
          Reference partOf
          The organization of which this organization forms a part.
        • qualification
          List<Organization.OrganizationQualificationComponent> qualification
          The official certifications, accreditations, training, designations and licenses that authorize and/or otherwise endorse the provision of care by the organization. For example, an approval to provide a type of services issued by a certifying body (such as the US Joint Commission) to an organization.
        • type
          List<CodeableConcept> type
          The kind(s) of organization that this is.

    • Class org.hl7.fhir.r5.model.Organization.OrganizationQualificationComponent

      class OrganizationQualificationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1561812204L

      • Serialized Fields

        • code
          CodeableConcept code
          Coded representation of the qualification.
        • identifier
          List<Identifier> identifier
          An identifier allocated to this qualification for this organization.
        • issuer
          Reference issuer
          Organization that regulates and issues the qualification.
        • period
          Period period
          Period during which the qualification is valid.

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

      class OrganizationAffiliation extends DomainResource implements Serializable
      serialVersionUID:
      -509714744L

      • Serialized Fields

        • active
          BooleanType active
          Whether this organization affiliation record is in active use.
        • code
          List<CodeableConcept> code
          Definition of the role the participatingOrganization plays in the association.
        • contact
          List<ExtendedContactDetail> contact
          The contact details of communication devices available at the participatingOrganization relevant to this Affiliation.
        • endpoint
          List<Reference> endpoint
          Technical endpoints providing access to services operated for this role.
        • healthcareService
          List<Reference> healthcareService
          Healthcare services provided through the role.
        • identifier
          List<Identifier> identifier
          Business identifiers that are specific to this role.
        • location
          List<Reference> location
          The location(s) at which the role occurs.
        • network
          List<Reference> network
          The network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).
        • organization
          Reference organization
          Organization where the role is available (primary organization/has members).
        • participatingOrganization
          Reference participatingOrganization
          The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of).
        • period
          Period period
          The period during which the participatingOrganization is affiliated with the primary organization.
        • specialty
          List<CodeableConcept> specialty
          Specific specialty of the participatingOrganization in the context of the role.

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

      class PackagedProductDefinition extends DomainResource implements Serializable
      serialVersionUID:
      -1670129447L

      • Serialized Fields

        • attachedDocument
          List<Reference> attachedDocument
          Additional information or supporting documentation about the packaged product.
        • characteristic
          List<PackagedProductDefinition.PackagedProductDefinitionPackagingPropertyComponent> characteristic
          Allows the key features to be recorded, such as "hospital pack", "nurse prescribable", "calendar pack".
        • containedItemQuantity
          List<Quantity> containedItemQuantity
          A total of the complete count of contained items of a particular type/form, independent of sub-packaging or organization. This can be considered as the pack size. This attribute differs from containedItem.amount in that it can give a single aggregated count of all tablet types in a pack, even when these are different manufactured items. For example a pill pack of 21 tablets plus 7 sugar tablets, can be denoted here as '28 tablets'. This attribute is repeatable so that the different item types in one pack type can be counted (e.g. a count of vials and count of syringes). Each repeat must have different units, so that it is clear what the different sets of counted items are, and it is not intended to allow different counts of similar items (e.g. not '2 tubes and 3 tubes'). Repeats are not to be used to represent different pack sizes (e.g. 20 pack vs. 50 pack) - which would be different instances of this resource.
        • copackagedIndicator
          BooleanType copackagedIndicator
          Identifies if the package contains different items, such as when a drug product is supplied with another item e.g. a diluent or adjuvant.
        • description
          MarkdownType description
          Textual description. Note that this is not the name of the package or product.
        • identifier
          List<Identifier> identifier
          A unique identifier for this package as whole - not the the content of the package. Unique instance identifiers assigned to a package by manufacturers, regulators, drug catalogue custodians or other organizations.
        • legalStatusOfSupply
          List<PackagedProductDefinition.PackagedProductDefinitionLegalStatusOfSupplyComponent> legalStatusOfSupply
          The legal status of supply of the packaged item as classified by the regulator.
        • manufacturer
          List<Reference> manufacturer
          Manufacturer of this package type. When there are multiple it means these are all possible manufacturers.
        • marketingStatus
          List<MarketingStatus> marketingStatus
          Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated.
        • name
          StringType name
          A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc.
        • packageFor
          List<Reference> packageFor
          The product this package model relates to, not the contents of the package (for which see package.containedItem).
        • packaging
          PackagedProductDefinition.PackagedProductDefinitionPackagingComponent packaging
          A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap (which is not a device or a medication manufactured item).
        • status
          CodeableConcept status
          The status within the lifecycle of this item. A high level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization or marketing status.
        • statusDate
          DateTimeType statusDate
          The date at which the given status became applicable.
        • type
          CodeableConcept type
          A high level category e.g. medicinal product, raw material, shipping/transport container, etc.

    • Class org.hl7.fhir.r5.model.PackagedProductDefinition.PackagedProductDefinitionLegalStatusOfSupplyComponent

      class PackagedProductDefinitionLegalStatusOfSupplyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1072410156L

      • Serialized Fields

        • code
          CodeableConcept code
          The actual status of supply. Conveys in what situation this package type may be supplied for use.
        • jurisdiction
          CodeableConcept jurisdiction
          The place where the legal status of supply applies. When not specified, this indicates it is unknown in this context.

    • Class org.hl7.fhir.r5.model.PackagedProductDefinition.PackagedProductDefinitionPackagingComponent

      class PackagedProductDefinitionPackagingComponent extends BackboneElement implements Serializable
      serialVersionUID:
      2121836225L

      • Serialized Fields

        • alternateMaterial
          List<CodeableConcept> alternateMaterial
          A possible alternate material for this part of the packaging, that is allowed to be used instead of the usual material (e.g. different types of plastic for a blister sleeve).
        • componentPart
          BooleanType componentPart
          Is this a part of the packaging (e.g. a cap or bottle stopper), rather than the packaging itself (e.g. a bottle or vial). The latter type are designed be a container, but the former are not.
        • containedItem
          List<PackagedProductDefinition.PackagedProductDefinitionPackagingContainedItemComponent> containedItem
          The item(s) within the packaging.
        • identifier
          List<Identifier> identifier
          A business identifier that is specific to this particular part of the packaging, often assigned by the manufacturer. Including possibly Data Carrier Identifier (a GS1 barcode).
        • manufacturer
          List<Reference> manufacturer
          Manufacturer of this packaging item. When there are multiple values each one is a potential manufacturer of this packaging item.
        • material
          List<CodeableConcept> material
          Material type of the package item.
        • packaging
          List<PackagedProductDefinition.PackagedProductDefinitionPackagingComponent> packaging
          Allows containers (and parts of containers) within containers, still as a part of a single packaged product. See also PackagedProductDefinition.packaging.containedItem.item(PackagedProductDefinition).
        • property
          List<PackagedProductDefinition.PackagedProductDefinitionPackagingPropertyComponent> property
          General characteristics of this item.
        • quantity
          IntegerType quantity
          The quantity of packaging items contained at this layer of the package. This does not relate to the number of contained items but relates solely to the number of packaging items. When looking at the outermost layer it is always 1. If there are two boxes within, at the next layer it would be 2.
        • shelfLifeStorage
          List<ProductShelfLife> shelfLifeStorage
          Shelf Life and storage information.
        • type
          CodeableConcept type
          The physical type of the container of the items.

    • Class org.hl7.fhir.r5.model.PackagedProductDefinition.PackagedProductDefinitionPackagingContainedItemComponent

      class PackagedProductDefinitionPackagingContainedItemComponent extends BackboneElement implements Serializable
      serialVersionUID:
      443863028L

      • Serialized Fields

        • amount
          Quantity amount
          The number of this type of item within this packaging or for continuous items such as liquids it is the quantity (for example 25ml). See also PackagedProductDefinition.containedItemQuantity (especially the long definition).
        • item
          CodeableReference item
          The actual item(s) of medication, as manufactured, or a device (typically, but not necessarily, a co-packaged one), or other medically related item (such as food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package. This also allows another whole packaged product to be included, which is solely for the case where a package of other entire packages is wanted - such as a wholesale or distribution pack (for layers within one package, use PackagedProductDefinition.packaging.packaging).

    • Class org.hl7.fhir.r5.model.PackagedProductDefinition.PackagedProductDefinitionPackagingPropertyComponent

      class PackagedProductDefinitionPackagingPropertyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1659186716L

      • Serialized Fields

        • type
          CodeableConcept type
          A code expressing the type of characteristic.
        • value
          DataType value
          A value for the characteristic.

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

      class ParameterDefinition extends DataType implements Serializable
      serialVersionUID:
      2027429213L

      • Serialized Fields

        • documentation
          StringType documentation
          A brief discussion of what the parameter is for and how it is used by the module.
        • max
          StringType max
          The maximum number of times this element is permitted to appear in the request or response.
        • min
          IntegerType min
          The minimum number of times this parameter SHALL appear in the request or response.
        • name
          CodeType name
          The name of the parameter used to allow access to the value of the parameter in evaluation contexts.
        • profile
          CanonicalType profile
          If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.
        • type
          Enumeration<Enumerations.FHIRTypes> type
          The type of the parameter.
        • use
          Enumeration<Enumerations.OperationParameterUse> use
          Whether the parameter is input or output for the module.

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

      class Parameters extends Resource implements Serializable
      serialVersionUID:
      -1495940293L

    • Class org.hl7.fhir.r5.model.Parameters.ParametersParameterComponent

      class ParametersParameterComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1755858390L

      • Serialized Fields

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

      class Patient extends DomainResource implements Serializable
      serialVersionUID:
      1376657499L

      • Serialized Fields

        • active
          BooleanType active
          Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.
        • address
          List<Address> address
          An address for the individual.
        • birthDate
          DateType birthDate
          The date of birth for the individual.
        • communication
          List<Patient.PatientCommunicationComponent> communication
          A language which may be used to communicate with the patient about his or her health.
        • contact
          List<Patient.ContactComponent> contact
          A contact party (e.g. guardian, partner, friend) for the patient.
        • deceased
          DataType deceased
          Indicates if the individual is deceased or not.
        • gender
          Enumeration<Enumerations.AdministrativeGender> gender
          Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
        • generalPractitioner
          List<Reference> generalPractitioner
          Patient's nominated care provider.
        • identifier
          List<Identifier> identifier
          An identifier for this patient.
        • link
          List<Patient.PatientLinkComponent> link
          Link to a Patient or RelatedPerson resource that concerns the same actual individual.
        • managingOrganization
          Reference managingOrganization
          Organization that is the custodian of the patient record.
        • maritalStatus
          CodeableConcept maritalStatus
          This field contains a patient's most recent marital (civil) status.
        • multipleBirth
          DataType multipleBirth
          Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
        • name
          List<HumanName> name
          A name associated with the individual.
        • photo
          List<Attachment> photo
          Image of the patient.
        • telecom
          List<ContactPoint> telecom
          A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

    • Class org.hl7.fhir.r5.model.Patient.ContactComponent

      class ContactComponent extends BackboneElement implements Serializable
      serialVersionUID:
      117984384L

      • Serialized Fields

        • address
          Address address
          Address for the contact person.
        • gender
          Enumeration<Enumerations.AdministrativeGender> gender
          Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.
        • name
          HumanName name
          A name associated with the contact person.
        • organization
          Reference organization
          Organization on behalf of which the contact is acting or for which the contact is working.
        • period
          Period period
          The period during which this contact person or organization is valid to be contacted relating to this patient.
        • relationship
          List<CodeableConcept> relationship
          The nature of the relationship between the patient and the contact person.
        • telecom
          List<ContactPoint> telecom
          A contact detail for the person, e.g. a telephone number or an email address.

    • Class org.hl7.fhir.r5.model.Patient.LinkTypeEnumFactory

      class LinkTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Patient.PatientCommunicationComponent

      class PatientCommunicationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      633792918L

      • Serialized Fields

        • language
          CodeableConcept language
          The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-AU" for Australian English.
        • preferred
          BooleanType preferred
          Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

    • Class org.hl7.fhir.r5.model.Patient.PatientLinkComponent

      class PatientLinkComponent extends BackboneElement implements Serializable
      serialVersionUID:
      182421394L

      • Serialized Fields

        • other
          Reference other
          Link to a Patient or RelatedPerson resource that concerns the same actual individual.
        • type
          Enumeration<Patient.LinkType> type
          The type of link between this patient resource and another patient resource.

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

      class PaymentNotice extends DomainResource implements Serializable
      serialVersionUID:
      1568561168L

      • Serialized Fields

        • amount
          Money amount
          The amount sent to the payee.
        • created
          DateTimeType created
          The date when this resource was created.
        • identifier
          List<Identifier> identifier
          A unique identifier assigned to this payment notice.
        • payee
          Reference payee
          The party who will receive or has received payment that is the subject of this notification.
        • payment
          Reference payment
          A reference to the payment which is the subject of this notice.
        • paymentDate
          DateType paymentDate
          The date when the above payment action occurred.
        • paymentStatus
          CodeableConcept paymentStatus
          A code indicating whether payment has been sent or cleared.
        • recipient
          Reference recipient
          The party who is notified of the payment status.
        • reporter
          Reference reporter
          The party who reports the payment notice.
        • request
          Reference request
          Reference of resource for which payment is being made.
        • response
          Reference response
          Reference of response to resource for which payment is being made.
        • status
          Enumeration<Enumerations.FinancialResourceStatusCodes> status
          The status of the resource instance.

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

      class PaymentReconciliation extends DomainResource implements Serializable
      serialVersionUID:
      705873820L

      • Serialized Fields

        • accountNumber
          StringType accountNumber
          A portion of the account number, often the last 4 digits, used for verification not charging purposes.
        • allocation
          List<PaymentReconciliation.PaymentReconciliationAllocationComponent> allocation
          Distribution of the payment amount for a previously acknowledged payable.
        • amount
          Money amount
          Total payment amount as indicated on the financial instrument.
        • authorization
          StringType authorization
          An alphanumeric issued by the processor to confirm the successful issuance of payment.
        • cardBrand
          StringType cardBrand
          The card brand such as debit, Visa, Amex etc. used if a card is the method of payment.
        • created
          DateTimeType created
          The date when the resource was created.
        • date
          DateType date
          The date of payment as indicated on the financial instrument.
        • disposition
          StringType disposition
          A human readable description of the status of the request for the reconciliation.
        • enterer
          Reference enterer
          Payment enterer if not the actual payment issuer.
        • expirationDate
          DateType expirationDate
          The year and month (YYYY-MM) when the instrument, typically card, expires.
        • formCode
          CodeableConcept formCode
          A code for the form to be used for printing the content.
        • identifier
          List<Identifier> identifier
          A unique identifier assigned to this payment reconciliation.
        • issuerType
          CodeableConcept issuerType
          The type of the source such as patient or insurance.
        • kind
          CodeableConcept kind
          The workflow or activity which gave rise to or during which the payment ocurred such as a kiosk, deposit on account, periodic payment etc.
        • location
          Reference location
          The location of the site or device for electronic transfers or physical location for cash payments.
        • method
          CodeableConcept method
          The means of payment such as check, card cash, or electronic funds transfer.
        • outcome
          Enumeration<PaymentReconciliation.PaymentOutcome> outcome
          The outcome of a request for a reconciliation.
        • paymentIdentifier
          Identifier paymentIdentifier
          Issuer's unique identifier for the payment instrument.
        • paymentIssuer
          Reference paymentIssuer
          The party who generated the payment.
        • period
          Period period
          The period of time for which payments have been gathered into this bulk payment for settlement.
        • processNote
          List<PaymentReconciliation.NotesComponent> processNote
          A note that describes or explains the processing in a human readable form.
        • processor
          StringType processor
          The name of the card processor, etf processor, bank for checks.
        • referenceNumber
          StringType referenceNumber
          The check number, eft reference, car processor reference.
        • request
          Reference request
          Original request resource reference.
        • requestor
          Reference requestor
          The practitioner who is responsible for the services rendered to the patient.
        • returnedAmount
          Money returnedAmount
          The amount returned by the receiver which is excess to the amount payable, often referred to as 'change'.
        • status
          Enumeration<Enumerations.FinancialResourceStatusCodes> status
          The status of the resource instance.
        • tenderedAmount
          Money tenderedAmount
          The amount offered by the issuer, typically applies to cash when the issuer provides an amount in bank note denominations equal to or excess of the amount actually being paid.
        • type
          CodeableConcept type
          Code to indicate the nature of the payment such as payment, adjustment.

    • Class org.hl7.fhir.r5.model.PaymentReconciliation.NotesComponent

      class NotesComponent extends BackboneElement implements Serializable
      serialVersionUID:
      529250161L

    • Class org.hl7.fhir.r5.model.PaymentReconciliation.NoteTypeEnumFactory

      class NoteTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.PaymentReconciliation.PaymentOutcomeEnumFactory

      class PaymentOutcomeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.PaymentReconciliation.PaymentReconciliationAllocationComponent

      class PaymentReconciliationAllocationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1153705409L

      • Serialized Fields

        • account
          Reference account
          The Account to which this payment applies, may be completed by the receiver, used for search.
        • amount
          Money amount
          The monetary amount allocated from the total payment to the payable.
        • date
          DateType date
          The date from the response resource containing a commitment to pay.
        • encounter
          Reference encounter
          The Encounter to which this payment applies, may be completed by the receiver, used for search.
        • identifier
          Identifier identifier
          Unique identifier for the current payment item for the referenced payable.
        • payee
          Reference payee
          The party which is receiving the payment.
        • predecessor
          Identifier predecessor
          Unique identifier for the prior payment item for the referenced payable.
        • response
          Reference response
          A resource, such as a ClaimResponse, which contains a commitment to payment.
        • responsible
          Reference responsible
          A reference to the individual who is responsible for inquiries regarding the response and its payment.
        • submitter
          Reference submitter
          The party which submitted the claim or financial transaction.
        • target
          Reference target
          Specific resource to which the payment/adjustment/advance applies.
        • targetItem
          DataType targetItem
          Identifies the claim line item, encounter or other sub-element being paid. Note payment may be partial, that is not match the then outstanding balance or amount incurred.
        • type
          CodeableConcept type
          Code to indicate the nature of the payment.

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

      class Period extends DataType implements Serializable
      serialVersionUID:
      649791751L

      • Serialized Fields

        • end
          DateTimeType end
          The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
        • start
          DateTimeType start
          The start of the period. The boundary is inclusive.

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

      class Permission extends DomainResource implements Serializable
      serialVersionUID:
      1252321973L

    • Class org.hl7.fhir.r5.model.Permission.PermissionJustificationComponent

      class PermissionJustificationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -2023272721L

      • Serialized Fields

        • basis
          List<CodeableConcept> basis
          This would be a codeableconcept, or a coding, which can be constrained to , for example, the 6 grounds for processing in GDPR.
        • evidence
          List<Reference> evidence
          Justifing rational.

    • Class org.hl7.fhir.r5.model.Permission.PermissionRuleCombiningEnumFactory

      class PermissionRuleCombiningEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Permission.PermissionStatusEnumFactory

      class PermissionStatusEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Permission.RuleActivityComponent

      class RuleActivityComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1403721720L

    • Class org.hl7.fhir.r5.model.Permission.RuleComponent

      class RuleComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1376717588L

    • Class org.hl7.fhir.r5.model.Permission.RuleDataComponent

      class RuleDataComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -774403139L

      • Serialized Fields

        • expression
          Expression expression
          Used when other data selection elements are insufficient.
        • period
          List<Period> period
          Clinical or Operational Relevant period of time that bounds the data controlled by this rule.
        • resource
          List<Permission.RuleDataResourceComponent> resource
          Explicit FHIR Resource references.
        • security
          List<Coding> security
          The data in scope are those with the given codes present in that data .meta.security element.

    • Class org.hl7.fhir.r5.model.Permission.RuleDataResourceComponent

      class RuleDataResourceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1735979153L

      • Serialized Fields

        • meaning
          Enumeration<Enumerations.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.Person

      class Person extends DomainResource implements Serializable
      serialVersionUID:
      -1871612358L

      • Serialized Fields

        • active
          BooleanType active
          Whether this person's record is in active use.
        • address
          List<Address> address
          One or more addresses for the person.
        • birthDate
          DateType birthDate
          The birth date for the person.
        • communication
          List<Person.PersonCommunicationComponent> communication
          A language which may be used to communicate with the person about his or her health.
        • deceased
          DataType deceased
          Indicates if the individual is deceased or not.
        • gender
          Enumeration<Enumerations.AdministrativeGender> gender
          Administrative Gender.
        • identifier
          List<Identifier> identifier
          Identifier for a person within a particular scope.
        • link
          List<Person.PersonLinkComponent> link
          Link to a resource that concerns the same actual person.
        • managingOrganization
          Reference managingOrganization
          The organization that is the custodian of the person record.
        • maritalStatus
          CodeableConcept maritalStatus
          This field contains a person's most recent marital (civil) status.
        • name
          List<HumanName> name
          A name associated with the person.
        • photo
          List<Attachment> photo
          An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.
        • telecom
          List<ContactPoint> telecom
          A contact detail for the person, e.g. a telephone number or an email address.

    • Class org.hl7.fhir.r5.model.Person.IdentityAssuranceLevelEnumFactory

      class IdentityAssuranceLevelEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Person.PersonCommunicationComponent

      class PersonCommunicationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      633792918L

      • Serialized Fields

        • language
          CodeableConcept language
          The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-AU" for Australian English.
        • preferred
          BooleanType preferred
          Indicates whether or not the person prefers this language (over other languages he masters up a certain level).

    • Class org.hl7.fhir.r5.model.Person.PersonLinkComponent

      class PersonLinkComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1393523223L

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

      class PlanDefinition extends MetadataResource implements Serializable
      serialVersionUID:
      324754414L

      • Serialized Fields

        • action
          List<PlanDefinition.PlanDefinitionActionComponent> action
          An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification.
        • actor
          List<PlanDefinition.PlanDefinitionActorComponent> actor
          Actors represent the individuals or groups involved in the execution of the defined set of activities.
        • 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.
        • asNeeded
          DataType asNeeded
          If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.
        • author
          List<ContactDetail> author
          An individiual or organization primarily involved in the creation and maintenance of the content.
        • 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 plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the plan definition was last significantly changed. 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 plan definition changes.
        • description
          MarkdownType description
          A free text natural language description of the plan definition from a consumer's perspective.
        • editor
          List<ContactDetail> editor
          An individual or organization primarily responsible for internal coherence of the content.
        • effectivePeriod
          Period effectivePeriod
          The period during which the plan definition content was or is planned to be in active use.
        • endorser
          List<ContactDetail> endorser
          An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        • goal
          List<PlanDefinition.PlanDefinitionGoalComponent> goal
          A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.
        • identifier
          List<Identifier> identifier
          A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
        • jurisdiction
          List<CodeableConcept> jurisdiction
          A legal or geographic region in which the plan 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.
        • library
          List<CanonicalType> library
          A reference to a Library resource containing any formal logic used by the plan definition.
        • name
          StringType name
          A natural language name identifying the plan 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 responsible for the release and ongoing maintenance of the plan definition.
        • purpose
          MarkdownType purpose
          Explanation of why this plan definition is needed and why it has been designed as it has.
        • relatedArtifact
          List<RelatedArtifact> relatedArtifact
          Related artifacts such as additional documentation, justification, or bibliographic references.
        • reviewer
          List<ContactDetail> reviewer
          An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this plan 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 plan definition. 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 plan definition giving additional information about its content.
        • title
          StringType title
          A short, descriptive, user-friendly title for the plan definition.
        • topic
          List<CodeableConcept> topic
          Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.
        • type
          CodeableConcept type
          A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.
        • url
          UriType url
          An absolute URI that is used to identify this plan 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 an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.
        • usage
          MarkdownType usage
          A detailed description of how the plan 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 plan definition instances.
        • version
          StringType version
          The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan 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 artifacts.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • Class org.hl7.fhir.r5.model.PlanDefinition.PlanDefinitionActionComponent

      class PlanDefinitionActionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1296604536L

      • Serialized Fields

        • action
          List<PlanDefinition.PlanDefinitionActionComponent> action
          Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.
        • cardinalityBehavior
          Enumeration<Enumerations.ActionCardinalityBehavior> cardinalityBehavior
          Defines whether the action can be selected multiple times.
        • code
          CodeableConcept code
          A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property.
        • condition
          List<PlanDefinition.PlanDefinitionActionConditionComponent> condition
          An expression that describes applicability criteria or start/stop conditions for the action.
        • definition
          DataType definition
          A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.
        • description
          MarkdownType description
          A brief description of the action used to provide a summary to display to the user.
        • documentation
          List<RelatedArtifact> documentation
          Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.
        • dynamicValue
          List<PlanDefinition.PlanDefinitionActionDynamicValueComponent> dynamicValue
          Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.
        • goalId
          List<IdType> goalId
          Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.
        • groupingBehavior
          Enumeration<Enumerations.ActionGroupingBehavior> groupingBehavior
          Defines the grouping behavior for the action and its children.
        • input
          List<PlanDefinition.PlanDefinitionActionInputComponent> input
          Defines input data requirements for the action.
        • linkId
          StringType linkId
          An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.
        • location
          CodeableReference location
          Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc.
        • output
          List<PlanDefinition.PlanDefinitionActionOutputComponent> output
          Defines the outputs of the action, if any.
        • participant
          List<PlanDefinition.PlanDefinitionActionParticipantComponent> participant
          Indicates who should participate in performing the action described.
        • precheckBehavior
          Enumeration<Enumerations.ActionPrecheckBehavior> precheckBehavior
          Defines whether the action should usually be preselected.
        • prefix
          StringType prefix
          A user-visible prefix for the action. For example a section or item numbering such as 1. or A.
        • priority
          Enumeration<Enumerations.RequestPriority> priority
          Indicates how quickly the action should be addressed with respect to other actions.
        • reason
          List<CodeableConcept> reason
          A description of why this action is necessary or appropriate.
        • relatedAction
          List<PlanDefinition.PlanDefinitionActionRelatedActionComponent> relatedAction
          A relationship to another action such as "before" or "30-60 minutes after start of".
        • requiredBehavior
          Enumeration<Enumerations.ActionRequiredBehavior> requiredBehavior
          Defines the required behavior for the action.
        • selectionBehavior
          Enumeration<Enumerations.ActionSelectionBehavior> selectionBehavior
          Defines the selection behavior for the action and its children.
        • subject
          DataType subject
          A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. 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.
        • textEquivalent
          MarkdownType textEquivalent
          A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.
        • timing
          DataType timing
          An optional value describing when the action should be performed.
        • title
          StringType title
          The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC.
        • transform
          CanonicalType transform
          A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
        • trigger
          List<TriggerDefinition> trigger
          A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.
        • type
          CodeableConcept type
          The type of action to perform (create, update, remove).

    • Class org.hl7.fhir.r5.model.PlanDefinition.PlanDefinitionActionConditionComponent

      class PlanDefinitionActionConditionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -455150438L

    • Class org.hl7.fhir.r5.model.PlanDefinition.PlanDefinitionActionDynamicValueComponent

      class PlanDefinitionActionDynamicValueComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1064529082L

      • Serialized Fields

        • expression
          Expression expression
          An expression specifying the value of the customized element.
        • path
          StringType path
          The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable 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.PlanDefinition.PlanDefinitionActionInputComponent

      class PlanDefinitionActionInputComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1064046709L

      • Serialized Fields

        • relatedData
          IdType relatedData
          Points to an existing input or output element that provides data to this input.
        • requirement
          DataRequirement requirement
          Defines the data that is to be provided as input to the action.
        • title
          StringType title
          A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.

    • Class org.hl7.fhir.r5.model.PlanDefinition.PlanDefinitionActionOutputComponent

      class PlanDefinitionActionOutputComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1822414421L

      • Serialized Fields

        • relatedData
          StringType relatedData
          Points to an existing input or output element that is results as output from the action.
        • requirement
          DataRequirement requirement
          Defines the data that results as output from the action.
        • title
          StringType title
          A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.

    • Class org.hl7.fhir.r5.model.PlanDefinition.PlanDefinitionActionParticipantComponent

      class PlanDefinitionActionParticipantComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1467052283L

      • Serialized Fields

        • actorId
          StringType actorId
          A reference to the id element of the actor who will participate in this action.
        • function
          CodeableConcept function
          Indicates how the actor will be involved in the action - author, reviewer, witness, etc.
        • role
          CodeableConcept role
          The role the participant should play in performing the described action.
        • type
          Enumeration<Enumerations.ActionParticipantType> type
          The type of participant in the action.
        • typeCanonical
          CanonicalType typeCanonical
          The type of participant in the action.
        • typeReference
          Reference typeReference
          The type of participant in the action.

    • Class org.hl7.fhir.r5.model.PlanDefinition.PlanDefinitionActionRelatedActionComponent

      class PlanDefinitionActionRelatedActionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1997058061L

    • Class org.hl7.fhir.r5.model.PlanDefinition.PlanDefinitionActorComponent

      class PlanDefinitionActorComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -571302300L

    • Class org.hl7.fhir.r5.model.PlanDefinition.PlanDefinitionActorOptionComponent

      class PlanDefinitionActorOptionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1881639157L

    • Class org.hl7.fhir.r5.model.PlanDefinition.PlanDefinitionGoalComponent

      class PlanDefinitionGoalComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -795308926L

      • Serialized Fields

        • addresses
          List<CodeableConcept> addresses
          Identifies problems, conditions, issues, or concerns the goal is intended to address.
        • category
          CodeableConcept category
          Indicates a category the goal falls within.
        • description
          CodeableConcept description
          Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".
        • documentation
          List<RelatedArtifact> documentation
          Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.
        • priority
          CodeableConcept priority
          Identifies the expected level of importance associated with reaching/sustaining the defined goal.
        • start
          CodeableConcept start
          The event after which the goal should begin being pursued.
        • target
          List<PlanDefinition.PlanDefinitionGoalTargetComponent> target
          Indicates what should be done and within what timeframe.

    • Class org.hl7.fhir.r5.model.PlanDefinition.PlanDefinitionGoalTargetComponent

      class PlanDefinitionGoalTargetComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1464475626L

      • Serialized Fields

        • detail
          DataType detail
          The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.
        • due
          Duration due
          Indicates the timeframe after the start of the goal in which the goal should be met.
        • measure
          CodeableConcept measure
          The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.

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

      class PositiveIntType extends IntegerType implements Externalizable
      serialVersionUID:
      1686497884249402429L

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

      class Practitioner extends DomainResource implements Serializable
      serialVersionUID:
      -54730811L

      • Serialized Fields

        • active
          BooleanType active
          Whether this practitioner's record is in active use.
        • address
          List<Address> address
          Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.
        • birthDate
          DateType birthDate
          The date of birth for the practitioner.
        • communication
          List<Practitioner.PractitionerCommunicationComponent> communication
          A language which may be used to communicate with the practitioner, often for correspondence/administrative purposes. The `PractitionerRole.communication` property should be used for publishing the languages that a practitioner is able to communicate with patients (on a per Organization/Role basis).
        • deceased
          DataType deceased
          Indicates if the practitioner is deceased or not.
        • gender
          Enumeration<Enumerations.AdministrativeGender> gender
          Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
        • identifier
          List<Identifier> identifier
          An identifier that applies to this person in this role.
        • name
          List<HumanName> name
          The name(s) associated with the practitioner.
        • photo
          List<Attachment> photo
          Image of the person.
        • qualification
          List<Practitioner.PractitionerQualificationComponent> qualification
          The official qualifications, certifications, accreditations, training, licenses (and other types of educations/skills/capabilities) that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board of licensure authorizing the practitioner to practice medicine within a certain locality.
        • telecom
          List<ContactPoint> telecom
          A contact detail for the practitioner, e.g. a telephone number or an email address.

    • Class org.hl7.fhir.r5.model.Practitioner.PractitionerCommunicationComponent

      class PractitionerCommunicationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      633792918L

      • Serialized Fields

        • language
          CodeableConcept language
          The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-AU" for Australian English.
        • preferred
          BooleanType preferred
          Indicates whether or not the person prefers this language (over other languages he masters up a certain level).

    • Class org.hl7.fhir.r5.model.Practitioner.PractitionerQualificationComponent

      class PractitionerQualificationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1561812204L

      • Serialized Fields

        • code
          CodeableConcept code
          Coded representation of the qualification.
        • identifier
          List<Identifier> identifier
          An identifier that applies to this person's qualification.
        • issuer
          Reference issuer
          Organization that regulates and issues the qualification.
        • period
          Period period
          Period during which the qualification is valid.

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

      class PractitionerRole extends DomainResource implements Serializable
      serialVersionUID:
      1286634270L

      • Serialized Fields

        • active
          BooleanType active
          Whether this practitioner role record is in active use. Some systems may use this property to mark non-active practitioners, such as those that are not currently employed.
        • availability
          List<Availability> availability
          A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
        • characteristic
          List<CodeableConcept> characteristic
          Collection of characteristics (attributes).
        • code
          List<CodeableConcept> code
          Roles which this practitioner is authorized to perform for the organization.
        • communication
          List<CodeableConcept> communication
          A language the practitioner can use in patient communication. The practitioner may know several languages (listed in practitioner.communication), however these are the languages that could be advertised in a directory for a patient to search.
        • contact
          List<ExtendedContactDetail> contact
          The contact details of communication devices available relevant to the specific PractitionerRole. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.
        • endpoint
          List<Reference> endpoint
          Technical endpoints providing access to services operated for the practitioner with this role. Commonly used for locating scheduling services, or identifying where to send referrals electronically.
        • healthcareService
          List<Reference> healthcareService
          The list of healthcare services that this worker provides for this role's Organization/Location(s).
        • identifier
          List<Identifier> identifier
          Business Identifiers that are specific to a role/location.
        • location
          List<Reference> location
          The location(s) at which this practitioner provides care.
        • organization
          Reference organization
          The organization where the Practitioner performs the roles associated.
        • period
          Period period
          The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
        • practitioner
          Reference practitioner
          Practitioner that is able to provide the defined services for the organization.
        • specialty
          List<CodeableConcept> specialty
          The specialty of a practitioner that describes the functional role they are practicing at a given organization or location.

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

      class PrimitiveType extends DataType implements Externalizable
      serialVersionUID:
      3L

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

      class Procedure extends DomainResource implements Serializable
      serialVersionUID:
      372127918L

      • Serialized Fields

        • basedOn
          List<Reference> basedOn
          A reference to a resource that contains details of the request for this procedure.
        • bodySite
          List<CodeableConcept> bodySite
          Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.
        • category
          List<CodeableConcept> category
          A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").
        • code
          CodeableConcept code
          The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy").
        • complication
          List<CodeableReference> complication
          Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.
        • encounter
          Reference encounter
          The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.
        • focalDevice
          List<Procedure.ProcedureFocalDeviceComponent> focalDevice
          A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.
        • focus
          Reference focus
          Who is the target of the procedure when it is not the subject of record only. If focus is not present, then subject is the focus. If focus is present and the subject is one of the targets of the procedure, include subject as a focus as well. If focus is present and the subject is not included in focus, it implies that the procedure was only targeted on the focus. For example, when a caregiver is given education for a patient, the caregiver would be the focus and the procedure record is associated with the subject (e.g. patient). For example, use focus when recording the target of the education, training, or counseling is the parent or relative of a patient.
        • followUp
          List<CodeableConcept> followUp
          If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.
        • identifier
          List<Identifier> identifier
          Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.
        • instantiatesCanonical
          List<CanonicalType> instantiatesCanonical
          The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.
        • instantiatesUri
          List<UriType> instantiatesUri
          The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.
        • location
          Reference location
          The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.
        • note
          List<Annotation> note
          Any other notes and comments about the procedure.
        • occurrence
          DataType occurrence
          Estimated or actual date, date-time, period, or age when the procedure did occur or is occurring. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
        • outcome
          CodeableConcept outcome
          The outcome of the procedure - did it resolve the reasons for the procedure being performed?
        • partOf
          List<Reference> partOf
          A larger event of which this particular procedure is a component or step.
        • performer
          List<Procedure.ProcedurePerformerComponent> performer
          Indicates who or what performed the procedure and how they were involved.
        • reason
          List<CodeableReference> reason
          The coded reason or reference why the procedure was performed. This may be a coded entity of some type, be present as text, or be a reference to one of several resources that justify the procedure.
        • recorded
          DateTimeType recorded
          The date the occurrence of the procedure was first captured in the record regardless of Procedure.status (potentially after the occurrence of the event).
        • recorder
          Reference recorder
          Individual who recorded the record and takes responsibility for its content.
        • report
          List<Reference> report
          This could be a histology result, pathology report, surgical report, etc.
        • 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.
        • status
          Enumeration<Enumerations.EventStatus> status
          A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.
        • statusReason
          CodeableConcept statusReason
          Captures the reason for the current state of the procedure.
        • subject
          Reference subject
          On whom or on what the procedure was performed. This is usually an individual human, but can also be performed on animals, groups of humans or animals, organizations or practitioners (for licensing), locations or devices (for safety inspections or regulatory authorizations). If the actual focus of the procedure is different from the subject, the focus element specifies the actual focus of the procedure.
        • supportingInfo
          List<Reference> supportingInfo
          Other resources from the patient record that may be relevant to the procedure. The information from these resources was either used to create the instance or is provided to help with its interpretation. This extension should not be used if more specific inline elements or extensions are available.
        • used
          List<CodeableReference> used
          Identifies medications, devices and any other substance used as part of the procedure.

    • Class org.hl7.fhir.r5.model.Procedure.ProcedureFocalDeviceComponent

      class ProcedureFocalDeviceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -217582010L

      • Serialized Fields

        • action
          CodeableConcept action
          The kind of change that happened to the device during the procedure.
        • manipulated
          Reference manipulated
          The device that was manipulated (changed) during the procedure.

    • Class org.hl7.fhir.r5.model.Procedure.ProcedurePerformerComponent

      class ProcedurePerformerComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1329650986L

      • Serialized Fields

        • actor
          Reference actor
          Indicates who or what performed the procedure.
        • function
          CodeableConcept function
          Distinguishes the type of involvement of the performer in the procedure. For example, surgeon, anaesthetist, endoscopist.
        • onBehalfOf
          Reference onBehalfOf
          The Organization the Patient, RelatedPerson, Device, CareTeam, and HealthcareService was acting on behalf of.
        • period
          Period period
          Time period during which the performer performed the procedure.

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

      class ProdCharacteristic extends BackboneType implements Serializable
      serialVersionUID:
      1521671432L

      • Serialized Fields

        • color
          List<StringType> color
          Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.
        • depth
          Quantity depth
          Where applicable, the depth can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.
        • externalDiameter
          Quantity externalDiameter
          Where applicable, the external diameter can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.
        • height
          Quantity height
          Where applicable, the height can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.
        • image
          List<Attachment> image
          Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations.
        • imprint
          List<StringType> imprint
          Where applicable, the imprint can be specified as text.
        • nominalVolume
          Quantity nominalVolume
          Where applicable, the nominal volume can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.
        • scoring
          CodeableConcept scoring
          Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.
        • shape
          StringType shape
          Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.
        • weight
          Quantity weight
          Where applicable, the weight can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.
        • width
          Quantity width
          Where applicable, the width can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.

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

      class ProductShelfLife extends BackboneType implements Serializable
      serialVersionUID:
      675017411L

      • Serialized Fields

        • period
          DataType period
          The shelf life time period can be specified using a numerical value for the period of time and its unit of time measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.
        • specialPrecautionsForStorage
          List<CodeableConcept> specialPrecautionsForStorage
          Special precautions for storage, if any, can be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified.
        • type
          CodeableConcept type
          This describes the shelf life, taking into account various scenarios such as shelf life of the packaged Medicinal Product itself, shelf life after transformation where necessary and shelf life after the first opening of a bottle, etc. The shelf life type shall be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified.

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

      class Provenance extends DomainResource implements Serializable
      serialVersionUID:
      2001521682L

      • Serialized Fields

        • activity
          CodeableConcept activity
          An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.
        • agent
          List<Provenance.ProvenanceAgentComponent> agent
          An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
        • authorization
          List<CodeableReference> 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.
        • 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<Provenance.ProvenanceEntityComponent> entity
          An entity used in this activity.
        • location
          Reference location
          Where the activity occurred, if relevant.
        • occurred
          DataType occurred
          The period during which the activity occurred.
        • patient
          Reference patient
          The patient element is available to enable deterministic tracking of activities that involve the patient as the subject of the data used in an activity.
        • policy
          List<UriType> policy
          Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.
        • recorded
          InstantType recorded
          The instant of time at which the activity was recorded.
        • signature
          List<Signature> signature
          A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.
        • target
          List<Reference> target
          The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.

    • Class org.hl7.fhir.r5.model.Provenance.ProvenanceAgentComponent

      class ProvenanceAgentComponent extends BackboneElement implements Serializable
      serialVersionUID:
      642650054L

      • Serialized Fields

        • onBehalfOf
          Reference onBehalfOf
          The agent that delegated authority to perform the activity performed by the agent.who element.
        • 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 agent with respect to the activity.
        • who
          Reference who
          Indicates who or what performed in the event.

    • Class org.hl7.fhir.r5.model.Provenance.ProvenanceEntityComponent

      class ProvenanceEntityComponent extends BackboneElement implements Serializable
      serialVersionUID:
      211110220L

      • Serialized Fields

        • agent
          List<Provenance.ProvenanceAgentComponent> agent
          The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which used the entity.
        • role
          Enumeration<Provenance.ProvenanceEntityRole> role
          How the entity was used during the activity.
        • what
          Reference what
          Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.

    • Class org.hl7.fhir.r5.model.Provenance.ProvenanceEntityRoleEnumFactory

      class ProvenanceEntityRoleEnumFactory extends Object implements Serializable

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

      class Quantity extends DataType implements Serializable
      serialVersionUID:
      1069574054L

      • Serialized Fields

        • code
          CodeType code
          A computer processable form of the unit in some unit representation system.
        • comparator
          Enumeration<Enumerations.QuantityComparator> comparator
          How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "invalid input: '<'" , then the real value is invalid input: '<' stated value.
        • system
          UriType system
          The identification of the system that provides the coded form of the unit.
        • unit
          StringType unit
          A human-readable form of the unit.
        • value
          DecimalType value
          The value of the measured amount. The value includes an implicit precision in the presentation of the value.

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

      class Questionnaire extends MetadataResource implements Serializable
      serialVersionUID:
      -863684953L

      • Serialized Fields

        • approvalDate
          DateType approvalDate
          The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
        • code
          List<Coding> code
          An identifier for this collection of questions in a particular terminology such as LOINC.
        • 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 questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the questionnaire was last significantly changed. 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 questionnaire changes.
        • derivedFrom
          List<CanonicalType> derivedFrom
          The URL of a Questionnaire that this Questionnaire is based on.
        • description
          MarkdownType description
          A free text natural language description of the questionnaire from a consumer's perspective.
        • effectivePeriod
          Period effectivePeriod
          The period during which the questionnaire content was or is planned to be in active use.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage.
        • identifier
          List<Identifier> identifier
          A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.
        • item
          List<Questionnaire.QuestionnaireItemComponent> item
          A particular question, question grouping or display text that is part of the questionnaire.
        • jurisdiction
          List<CodeableConcept> jurisdiction
          A legal or geographic region in which the questionnaire 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 questionnaire. 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 responsible for the release and ongoing maintenance of the questionnaire.
        • purpose
          MarkdownType purpose
          Explanation of why this questionnaire is needed and why it has been designed as it has.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The current state of this questionnaire.
        • subjectType
          List<CodeType> subjectType
          The types of subjects that can be the subject of responses created for the questionnaire.
        • title
          StringType title
          A short, descriptive, user-friendly title for the questionnaire.
        • url
          UriType url
          An absolute URI that is used to identify this questionnaire 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 an authoritative instance of this questionnaire is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the questionnaire 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 questionnaires.
        • version
          StringType version
          The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • Class org.hl7.fhir.r5.model.Questionnaire.EnableWhenBehaviorEnumFactory

      class EnableWhenBehaviorEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Questionnaire.QuestionnaireAnswerConstraintEnumFactory

      class QuestionnaireAnswerConstraintEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Questionnaire.QuestionnaireItemAnswerOptionComponent

      class QuestionnaireItemAnswerOptionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -504460934L

      • Serialized Fields

        • initialSelected
          BooleanType initialSelected
          Indicates whether the answer value is selected when the list of possible answers is initially shown.
        • value
          DataType value
          A potential answer that's allowed as the answer to this question.

    • Class org.hl7.fhir.r5.model.Questionnaire.QuestionnaireItemComponent

      class QuestionnaireItemComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1760914161L

      • Serialized Fields

        • answerConstraint
          Enumeration<Questionnaire.QuestionnaireAnswerConstraint> answerConstraint
          For items that have a defined set of allowed answers (via answerOption or answerValueSet), indicates whether values *other* than those specified can be selected.
        • answerOption
          List<Questionnaire.QuestionnaireItemAnswerOptionComponent> answerOption
          One of the permitted answers for the question.
        • answerValueSet
          CanonicalType answerValueSet
          A reference to a value set containing a list of values representing permitted answers for a question.
        • code
          List<Coding> code
          A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).
        • definition
          UriType definition
          This element is a URI that refers to an [ElementDefinition](elementdefinition.html) or to an [ObservationDefinition](observationdefinition.html) that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource. A detailed description of the construction of the URI is shown in [Comments](questionnaire.html#definition), below.
        • disabledDisplay
          Enumeration<Questionnaire.QuestionnaireItemDisabledDisplay> disabledDisplay
          Indicates if and how items that are disabled (because enableWhen evaluates to 'false') should be displayed.
        • enableBehavior
          Enumeration<Questionnaire.EnableWhenBehavior> enableBehavior
          Controls how multiple enableWhen values are interpreted - whether all or any must be true.
        • enableWhen
          List<Questionnaire.QuestionnaireItemEnableWhenComponent> enableWhen
          A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.
        • initial
          List<Questionnaire.QuestionnaireItemInitialComponent> initial
          One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input.
        • item
          List<Questionnaire.QuestionnaireItemComponent> item
          Text, questions and other groups to be nested beneath a question or group.
        • linkId
          StringType linkId
          An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.
        • maxLength
          IntegerType maxLength
          The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse.
        • prefix
          StringType prefix
          A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.
        • readOnly
          BooleanType readOnly
          An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.
        • repeats
          BooleanType repeats
          An indication, if true, that a QuestionnaireResponse for this item may include multiple answers associated with a single instance of this item (for question-type items) or multiple repetitions of the item (for group-type items).
        • required
          BooleanType required
          An indication, if true, that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.
        • text
          StringType text
          The name of a section, the text of a question or text content for a display item.
        • type
          Enumeration<Questionnaire.QuestionnaireItemType> type
          The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, Coding, etc.).

    • Class org.hl7.fhir.r5.model.Questionnaire.QuestionnaireItemDisabledDisplayEnumFactory

      class QuestionnaireItemDisabledDisplayEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Questionnaire.QuestionnaireItemEnableWhenComponent

      class QuestionnaireItemEnableWhenComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1909865374L

      • Serialized Fields

        • answer
          DataType answer
          A value that the referenced question is tested using the specified operator in order for the item to be enabled. If there are multiple answers, a match on any of the answers suffices. If different behavior is desired (all must match, at least 2 must match, etc.), consider using the enableWhenExpression extension.
        • operator
          Enumeration<Questionnaire.QuestionnaireItemOperator> operator
          Specifies the criteria by which the question is enabled.
        • question
          StringType question
          The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.

    • Class org.hl7.fhir.r5.model.Questionnaire.QuestionnaireItemInitialComponent

      class QuestionnaireItemInitialComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1135414639L

      • Serialized Fields

        • value
          DataType value
          The actual value to for an initial answer.

    • Class org.hl7.fhir.r5.model.Questionnaire.QuestionnaireItemOperatorEnumFactory

      class QuestionnaireItemOperatorEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Questionnaire.QuestionnaireItemTypeEnumFactory

      class QuestionnaireItemTypeEnumFactory extends Object implements Serializable

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

      class QuestionnaireResponse extends DomainResource implements Serializable
      serialVersionUID:
      1660467089L

      • Serialized Fields

        • author
          Reference author
          The individual or device that received the answers to the questions in the QuestionnaireResponse and recorded them in the system.
        • authored
          DateTimeType authored
          The date and/or time that this questionnaire response was last modified by the user - e.g. changing answers or revising status.
        • basedOn
          List<Reference> basedOn
          A plan, proposal or order that is fulfilled in whole or in part by this questionnaire response. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.
        • encounter
          Reference encounter
          The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.
        • identifier
          List<Identifier> identifier
          Business identifiers assigned to this questionnaire response by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.
        • item
          List<QuestionnaireResponse.QuestionnaireResponseItemComponent> item
          A group or question item from the original questionnaire for which answers are provided.
        • partOf
          List<Reference> partOf
          A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of.
        • questionnaire
          CanonicalType questionnaire
          The Questionnaire that defines and organizes the questions for which answers are being provided.
        • source
          Reference source
          The individual or device that answered the questions about the subject.
        • status
          Enumeration<QuestionnaireResponse.QuestionnaireResponseStatus> status
          The current state of the questionnaire response.
        • subject
          Reference subject
          The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information.

    • Class org.hl7.fhir.r5.model.QuestionnaireResponse.QuestionnaireResponseItemAnswerComponent

      class QuestionnaireResponseItemAnswerComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1790747618L

    • Class org.hl7.fhir.r5.model.QuestionnaireResponse.QuestionnaireResponseItemComponent

      class QuestionnaireResponseItemComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1395483402L

    • Class org.hl7.fhir.r5.model.QuestionnaireResponse.QuestionnaireResponseStatusEnumFactory

      class QuestionnaireResponseStatusEnumFactory extends Object implements Serializable

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

      class Range extends DataType implements Serializable
      serialVersionUID:
      -474933350L

      • Serialized Fields

        • high
          Quantity high
          The high limit. The boundary is inclusive.
        • low
          Quantity low
          The low limit. The boundary is inclusive.

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

      class Ratio extends DataType implements Serializable
      serialVersionUID:
      479922563L

      • Serialized Fields

        • denominator
          Quantity denominator
          The value of the denominator.
        • numerator
          Quantity numerator
          The value of the numerator.

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

      class RatioRange extends DataType implements Serializable
      serialVersionUID:
      -1691080287L

      • Serialized Fields

        • denominator
          Quantity denominator
          The value of the denominator.
        • highNumerator
          Quantity highNumerator
          The value of the high limit numerator.
        • lowNumerator
          Quantity lowNumerator
          The value of the low limit numerator.

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

      class Reference extends BaseReference implements Serializable
      serialVersionUID:
      784245805L

      • Serialized Fields

        • display
          StringType display
          Plain text narrative that identifies the resource in addition to the resource reference.
        • identifier
          Identifier identifier
          An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
        • reference
          StringType reference
          A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
        • type
          UriType type
          The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

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

      class RegulatedAuthorization extends DomainResource implements Serializable
      serialVersionUID:
      1227409639L

      • Serialized Fields

        • attachedDocument
          List<Reference> attachedDocument
          Additional information or supporting documentation about the authorization.
        • basis
          List<CodeableConcept> basis
          The legal or regulatory framework against which this authorization is granted, or other reasons for it.
        • case_
          RegulatedAuthorization.RegulatedAuthorizationCaseComponent case_
          The case or regulatory procedure for granting or amending a regulated authorization. An authorization is granted in response to submissions/applications by those seeking authorization. A case is the administrative process that deals with the application(s) that relate to this and assesses them. Note: This area is subject to ongoing review and the workgroup is seeking implementer feedback on its use (see link at bottom of page).
        • description
          MarkdownType description
          General textual supporting information.
        • holder
          Reference holder
          The organization that has been granted this authorization, by some authoritative body (the 'regulator').
        • identifier
          List<Identifier> identifier
          Business identifier for the authorization, typically assigned by the authorizing body.
        • indication
          List<CodeableReference> indication
          Condition for which the use of the regulated product applies.
        • intendedUse
          CodeableConcept intendedUse
          The intended use of the product, e.g. prevention, treatment, diagnosis.
        • region
          List<CodeableConcept> region
          The territory (e.g., country, jurisdiction etc.) in which the authorization has been granted.
        • regulator
          Reference regulator
          The regulatory authority or authorizing body granting the authorization. For example, European Medicines Agency (EMA), Food and Drug Administration (FDA), Health Canada (HC), etc.
        • status
          CodeableConcept status
          The status that is authorised e.g. approved. Intermediate states and actions can be tracked with cases and applications.
        • statusDate
          DateTimeType statusDate
          The date at which the current status was assigned.
        • subject
          List<Reference> subject
          The product type, treatment, facility or activity that is being authorized.
        • type
          CodeableConcept type
          Overall type of this authorization, for example drug marketing approval, orphan drug designation.
        • validityPeriod
          Period validityPeriod
          The time period in which the regulatory approval, clearance or licencing is in effect. As an example, a Marketing Authorization includes the date of authorization and/or an expiration date.

    • Class org.hl7.fhir.r5.model.RegulatedAuthorization.RegulatedAuthorizationCaseComponent

      class RegulatedAuthorizationCaseComponent extends BackboneElement implements Serializable
      serialVersionUID:
      2052202113L

      • Serialized Fields

        • application
          List<RegulatedAuthorization.RegulatedAuthorizationCaseComponent> application
          A regulatory submission from an organization to a regulator, as part of an assessing case. Multiple applications may occur over time, with more or different information to support or modify the submission or the authorization. The applications can be considered as steps within the longer running case or procedure for this authorization process.
        • date
          DataType date
          Relevant date for this case.
        • identifier
          Identifier identifier
          Identifier by which this case can be referenced.
        • status
          CodeableConcept status
          The status associated with the case.
        • type
          CodeableConcept type
          The defining type of case.

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

      class RelatedArtifact extends DataType implements Serializable
      serialVersionUID:
      556640693L

      • Serialized Fields

        • citation
          MarkdownType citation
          A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
        • classifier
          List<CodeableConcept> classifier
          Provides additional classifiers of the related artifact.
        • display
          StringType display
          A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
        • document
          Attachment document
          The document being referenced, represented as an attachment. This is exclusive with the resource element.
        • label
          StringType label
          A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.
        • publicationDate
          DateType publicationDate
          The date of publication of the artifact being referred to.
        • publicationStatus
          Enumeration<Enumerations.PublicationStatus> publicationStatus
          The publication status of the artifact being referred to.
        • resource
          CanonicalType resource
          The related artifact, such as a library, value set, profile, or other knowledge resource.
        • resourceReference
          Reference resourceReference
          The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.
        • type
          Enumeration<RelatedArtifact.RelatedArtifactType> type
          The type of relationship to the related artifact.

    • Class org.hl7.fhir.r5.model.RelatedArtifact.RelatedArtifactTypeEnumFactory

      class RelatedArtifactTypeEnumFactory extends Object implements Serializable

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

      class RelatedPerson extends DomainResource implements Serializable
      serialVersionUID:
      -857475397L

      • Serialized Fields

        • active
          BooleanType active
          Whether this related person record is in active use.
        • address
          List<Address> address
          Address where the related person can be contacted or visited.
        • birthDate
          DateType birthDate
          The date on which the related person was born.
        • communication
          List<RelatedPerson.RelatedPersonCommunicationComponent> communication
          A language which may be used to communicate with the related person about the patient's health.
        • gender
          Enumeration<Enumerations.AdministrativeGender> gender
          Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
        • identifier
          List<Identifier> identifier
          Identifier for a person within a particular scope.
        • name
          List<HumanName> name
          A name associated with the person.
        • patient
          Reference patient
          The patient this person is related to.
        • period
          Period period
          The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.
        • photo
          List<Attachment> photo
          Image of the person.
        • relationship
          List<CodeableConcept> relationship
          The nature of the relationship between the related person and the patient.
        • telecom
          List<ContactPoint> telecom
          A contact detail for the person, e.g. a telephone number or an email address.

    • Class org.hl7.fhir.r5.model.RelatedPerson.RelatedPersonCommunicationComponent

      class RelatedPersonCommunicationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      633792918L

      • Serialized Fields

        • language
          CodeableConcept language
          The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-AU" for Australian English.
        • preferred
          BooleanType preferred
          Indicates whether or not the related person prefers this language (over other languages he or she masters up a certain level).

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

      class RequestOrchestration extends DomainResource implements Serializable
      serialVersionUID:
      -683989911L

      • Serialized Fields

        • action
          List<RequestOrchestration.RequestOrchestrationActionComponent> action
          The actions, if any, produced by the evaluation of the artifact.
        • author
          Reference author
          Provides a reference to the author of the request orchestration.
        • authoredOn
          DateTimeType authoredOn
          Indicates when the request orchestration was created.
        • basedOn
          List<Reference> basedOn
          A plan, proposal or order that is fulfilled in whole or in part by this request.
        • code
          CodeableConcept code
          A code that identifies what the overall request orchestration is.
        • encounter
          Reference encounter
          Describes the context of the request orchestration, if any.
        • goal
          List<Reference> goal
          Goals that are intended to be achieved by following the requests in this RequestOrchestration.
        • groupIdentifier
          Identifier groupIdentifier
          A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.
        • identifier
          List<Identifier> identifier
          Allows a service to provide a unique, business identifier for the request.
        • instantiatesCanonical
          List<CanonicalType> instantiatesCanonical
          A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
        • instantiatesUri
          List<UriType> instantiatesUri
          A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
        • intent
          Enumeration<Enumerations.RequestIntent> intent
          Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.
        • note
          List<Annotation> note
          Provides a mechanism to communicate additional information about the response.
        • priority
          Enumeration<Enumerations.RequestPriority> priority
          Indicates how quickly the request should be addressed with respect to other requests.
        • reason
          List<CodeableReference> reason
          Describes the reason for the request orchestration in coded or textual form.
        • replaces
          List<Reference> replaces
          Completed or terminated request(s) whose function is taken by this new request.
        • status
          Enumeration<Enumerations.RequestStatus> status
          The current state of the request. For request orchestrations, the status reflects the status of all the requests in the orchestration.
        • subject
          Reference subject
          The subject for which the request orchestration was created.

    • Class org.hl7.fhir.r5.model.RequestOrchestration.RequestOrchestrationActionComponent

      class RequestOrchestrationActionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1292193514L

    • Class org.hl7.fhir.r5.model.RequestOrchestration.RequestOrchestrationActionConditionComponent

      class RequestOrchestrationActionConditionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -455150438L

    • Class org.hl7.fhir.r5.model.RequestOrchestration.RequestOrchestrationActionDynamicValueComponent

      class RequestOrchestrationActionDynamicValueComponent 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 resolvable 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.RequestOrchestration.RequestOrchestrationActionInputComponent

      class RequestOrchestrationActionInputComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1064046709L

      • Serialized Fields

        • relatedData
          IdType relatedData
          Points to an existing input or output element that provides data to this input.
        • requirement
          DataRequirement requirement
          Defines the data that is to be provided as input to the action.
        • title
          StringType title
          A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.

    • Class org.hl7.fhir.r5.model.RequestOrchestration.RequestOrchestrationActionOutputComponent

      class RequestOrchestrationActionOutputComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1822414421L

      • Serialized Fields

        • relatedData
          StringType relatedData
          Points to an existing input or output element that is results as output from the action.
        • requirement
          DataRequirement requirement
          Defines the data that results as output from the action.
        • title
          StringType title
          A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.

    • Class org.hl7.fhir.r5.model.RequestOrchestration.RequestOrchestrationActionParticipantComponent

      class RequestOrchestrationActionParticipantComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -147206285L

      • Serialized Fields

        • actor
          DataType actor
          A reference to the actual participant.
        • function
          CodeableConcept function
          Indicates how the actor will be involved in the action - author, reviewer, witness, etc.
        • role
          CodeableConcept role
          The role the participant should play in performing the described action.
        • type
          Enumeration<Enumerations.ActionParticipantType> type
          The type of participant in the action.
        • typeCanonical
          CanonicalType typeCanonical
          The type of participant in the action.
        • typeReference
          Reference typeReference
          The type of participant in the action.

    • Class org.hl7.fhir.r5.model.RequestOrchestration.RequestOrchestrationActionRelatedActionComponent

      class RequestOrchestrationActionRelatedActionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1997058061L

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

      class Requirements extends CanonicalResource implements Serializable
      serialVersionUID:
      -395151267L

      • Serialized Fields

        • actor
          List<CanonicalType> actor
          An actor these requirements are in regard to.
        • 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 Requirements and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the Requirements.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the Requirements 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 Requirements changes.
        • derivedFrom
          List<CanonicalType> derivedFrom
          Another set of Requirements that this set of Requirements builds on and updates.
        • description
          MarkdownType description
          A free text natural language description of the requirements.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this Requirements 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 Requirements 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 Requirements is intended to be used.
        • name
          StringType name
          A natural language name identifying the Requirements. 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 responsible for the release and ongoing maintenance of the Requirements.
        • purpose
          MarkdownType purpose
          Explanation of why this Requirements is needed and why it has been designed as it has.
        • reference
          List<UrlType> reference
          A reference to another artifact that created this set of requirements. This could be a Profile, etc., or external regulation, or business requirements expressed elsewhere.
        • statement
          List<Requirements.RequirementsStatementComponent> statement
          The actual statement of requirement, in markdown format.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this Requirements. Enables tracking the life-cycle of the content.
        • title
          StringType title
          A short, descriptive, user-friendly title for the Requirements.
        • url
          UriType url
          An absolute URI that is used to identify this Requirements 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 an authoritative instance of this Requirements is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Requirements 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 Requirements instances.
        • version
          StringType version
          The identifier that is used to identify this version of the Requirements when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Requirements 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • Class org.hl7.fhir.r5.model.Requirements.ConformanceExpectationEnumFactory

      class ConformanceExpectationEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Requirements.RequirementsStatementComponent

      class RequirementsStatementComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1299503021L

      • Serialized Fields

        • conditionality
          BooleanType conditionality
          This boolean flag is set to true of the text of the requirement is conditional on something e.g. it includes lanauage like 'if x then y'. This conditionality flag is introduced for purposes of filtering and colour highlighting etc.
        • conformance
          List<Enumeration<Requirements.ConformanceExpectation>> conformance
          A short human usable label for this statement.
        • derivedFrom
          StringType derivedFrom
          Another statement on one of the requirements that this requirement clarifies or restricts.
        • key
          IdType key
          Key that identifies this statement (unique within this resource).
        • label
          StringType label
          A short human usable label for this statement.
        • parent
          StringType parent
          A larger requirement that this requirement helps to refine and enable.
        • reference
          List<UrlType> reference
          A reference to another artifact that created this requirement. This could be a Profile, etc., or external regulation, or business requirements expressed elsewhere.
        • requirement
          MarkdownType requirement
          The actual requirement for human consumption.
        • satisfiedBy
          List<UrlType> satisfiedBy
          A reference to another artifact that satisfies this requirement. This could be a Profile, extension, or an element in one of those, or a CapabilityStatement, OperationDefinition, SearchParameter, CodeSystem(/code), ValueSet, Libary etc.
        • source
          List<Reference> source
          Who asked for this statement to be a requirement. By default, it's assumed that the publisher knows who it is if it matters.

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

      class ResearchStudy extends DomainResource implements Serializable
      serialVersionUID:
      -1217395129L

      • Serialized Fields

        • associatedParty
          List<ResearchStudy.ResearchStudyAssociatedPartyComponent> associatedParty
          Sponsors, collaborators, and other parties.
        • classifier
          List<CodeableConcept> classifier
          Additional grouping mechanism or categorization of a research study. Example: FDA regulated device, FDA regulated drug, MPG Paragraph 23b (a German legal requirement), IRB-exempt, etc. Implementation Note: do not use the classifier element to support existing semantics that are already supported thru explicit elements in the resource.
        • comparisonGroup
          List<ResearchStudy.ResearchStudyComparisonGroupComponent> comparisonGroup
          Describes an expected event or sequence of events for one of the subjects of a study. E.g. for a living subject: exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up. E.g. for a stability study: {store sample from lot A at 25 degrees for 1 month}, {store sample from lot A at 40 degrees for 1 month}.
        • condition
          List<CodeableConcept> condition
          The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion "healthy volunteer", but the target condition code would be a Lupus SNOMED code.
        • date
          DateTimeType date
          The date (and optionally time) when the ResearchStudy Resource was last significantly changed. 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 ResearchStudy Resource changes.
        • description
          MarkdownType description
          A detailed and human-readable narrative of the study. E.g., study abstract.
        • descriptionSummary
          MarkdownType descriptionSummary
          A brief text for explaining the study.
        • focus
          List<CodeableReference> focus
          The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.
        • identifier
          List<Identifier> identifier
          Identifiers assigned to this research study by the sponsor or other systems.
        • keyword
          List<CodeableConcept> keyword
          Key terms to aid in searching for or filtering the study.
        • label
          List<ResearchStudy.ResearchStudyLabelComponent> label
          Additional names for the study.
        • name
          StringType name
          Name for this study (computer friendly).
        • note
          List<Annotation> note
          Comments made about the study by the performer, subject or other participants.
        • objective
          List<ResearchStudy.ResearchStudyObjectiveComponent> objective
          A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study.
        • outcomeMeasure
          List<ResearchStudy.ResearchStudyOutcomeMeasureComponent> outcomeMeasure
          An "outcome measure", "endpoint", "effect measure" or "measure of effect" is a specific measurement or observation used to quantify the effect of experimental variables on the participants in a study, or for observational studies, to describe patterns of diseases or traits or associations with exposures, risk factors or treatment.
        • partOf
          List<Reference> partOf
          A larger research study of which this particular study is a component or step.
        • period
          Period period
          Identifies the start date and the expected (or actual, depending on status) end date for the study.
        • phase
          CodeableConcept phase
          The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.
        • primaryPurposeType
          CodeableConcept primaryPurposeType
          The type of study based upon the intent of the study activities. A classification of the intent of the study.
        • progressStatus
          List<ResearchStudy.ResearchStudyProgressStatusComponent> progressStatus
          Status of study with time for that status.
        • protocol
          List<Reference> protocol
          The set of steps expected to be performed as part of the execution of the study.
        • recruitment
          ResearchStudy.ResearchStudyRecruitmentComponent recruitment
          Target or actual group of participants enrolled in study.
        • region
          List<CodeableConcept> region
          A country, state or other area where the study is taking place rather than its precise geographic location or address.
        • relatedArtifact
          List<RelatedArtifact> relatedArtifact
          Citations, references, URLs and other related documents. When using relatedArtifact to share URLs, the relatedArtifact.type will often be set to one of "documentation" or "supported-with" and the URL value will often be in relatedArtifact.document.url but another possible location is relatedArtifact.resource when it is a canonical URL.
        • result
          List<Reference> result
          Link to one or more sets of results generated by the study. Could also link to a research registry holding the results such as ClinicalTrials.gov.
        • site
          List<Reference> site
          A facility in which study activities are conducted.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The publication state of the resource (not of the study).
        • studyDesign
          List<CodeableConcept> studyDesign
          Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.
        • title
          StringType title
          The human readable name of the research study.
        • url
          UriType url
          Canonical identifier for this study resource, represented as a globally unique URI.
        • version
          StringType version
          The business version for the study record.
        • whyStopped
          CodeableConcept whyStopped
          A description and/or code explaining the premature termination of the study.

    • Class org.hl7.fhir.r5.model.ResearchStudy.ResearchStudyAssociatedPartyComponent

      class ResearchStudyAssociatedPartyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1418550998L

      • Serialized Fields

        • classifier
          List<CodeableConcept> classifier
          A categorization other than role for the associated party.
        • name
          StringType name
          Name of associated party.
        • party
          Reference party
          Individual or organization associated with study (use practitionerRole to specify their organisation).
        • period
          List<Period> period
          Identifies the start date and the end date of the associated party in the role.
        • role
          CodeableConcept role
          Type of association.

    • Class org.hl7.fhir.r5.model.ResearchStudy.ResearchStudyComparisonGroupComponent

      class ResearchStudyComparisonGroupComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1107310853L

      • Serialized Fields

        • description
          MarkdownType description
          A succinct description of the path through the study that would be followed by a subject adhering to this comparisonGroup.
        • intendedExposure
          List<Reference> intendedExposure
          Interventions or exposures in this comparisonGroup or cohort.
        • linkId
          IdType linkId
          Allows the comparisonGroup for the study and the comparisonGroup for the subject to be linked easily.
        • name
          StringType name
          Unique, human-readable label for this comparisonGroup of the study.
        • observedGroup
          Reference observedGroup
          Group of participants who were enrolled in study comparisonGroup.
        • type
          CodeableConcept type
          Categorization of study comparisonGroup, e.g. experimental, active comparator, placebo comparater.

    • Class org.hl7.fhir.r5.model.ResearchStudy.ResearchStudyLabelComponent

      class ResearchStudyLabelComponent extends BackboneElement implements Serializable
      serialVersionUID:
      944223389L

    • Class org.hl7.fhir.r5.model.ResearchStudy.ResearchStudyObjectiveComponent

      class ResearchStudyObjectiveComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1976083810L

      • Serialized Fields

        • description
          MarkdownType description
          Free text description of the objective of the study. This is what the study is trying to achieve rather than how it is going to achieve it (see ResearchStudy.description).
        • name
          StringType name
          Unique, human-readable label for this objective of the study.
        • type
          CodeableConcept type
          The kind of study objective.

    • Class org.hl7.fhir.r5.model.ResearchStudy.ResearchStudyOutcomeMeasureComponent

      class ResearchStudyOutcomeMeasureComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1786559672L

      • Serialized Fields

        • description
          MarkdownType description
          Description of the outcome.
        • name
          StringType name
          Label for the outcome.
        • reference
          Reference reference
          Structured outcome definition.
        • type
          List<CodeableConcept> type
          The parameter or characteristic being assessed as one of the values by which the study is assessed.

    • Class org.hl7.fhir.r5.model.ResearchStudy.ResearchStudyProgressStatusComponent

      class ResearchStudyProgressStatusComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1232680620L

      • Serialized Fields

        • actual
          BooleanType actual
          An indication of whether or not the date is a known date when the state changed or will change. A value of true indicates a known date. A value of false indicates an estimated date.
        • period
          Period period
          Date range.
        • state
          CodeableConcept state
          Label for status or state (e.g. recruitment status).

    • Class org.hl7.fhir.r5.model.ResearchStudy.ResearchStudyRecruitmentComponent

      class ResearchStudyRecruitmentComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1483229827L

      • Serialized Fields

        • actualGroup
          Reference actualGroup
          Group of participants who were enrolled in study.
        • actualNumber
          UnsignedIntType actualNumber
          Actual total number of participants enrolled in study.
        • eligibility
          Reference eligibility
          Inclusion and exclusion criteria.
        • targetNumber
          UnsignedIntType targetNumber
          Estimated total number of participants to be enrolled.

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

      class ResearchSubject extends DomainResource implements Serializable
      serialVersionUID:
      -1058527147L

      • Serialized Fields

        • actualComparisonGroup
          IdType actualComparisonGroup
          The name of the arm in the study the subject actually followed as part of this study.
        • assignedComparisonGroup
          IdType assignedComparisonGroup
          The name of the arm in the study the subject is expected to follow as part of this study.
        • consent
          List<Reference> consent
          A record of the patient's informed agreement to participate in the study.
        • identifier
          List<Identifier> identifier
          Identifiers assigned to this research subject for a study.
        • period
          Period period
          The dates the subject began and ended their participation in the study.
        • progress
          List<ResearchSubject.ResearchSubjectProgressComponent> progress
          The current state (status) of the subject and resons for status change where appropriate.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The publication state of the resource (not of the subject).
        • study
          Reference study
          Reference to the study the subject is participating in.
        • subject
          Reference subject
          The record of the person, animal or other entity involved in the study.

    • Class org.hl7.fhir.r5.model.ResearchSubject.ResearchSubjectProgressComponent

      class ResearchSubjectProgressComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -330838916L

      • Serialized Fields

        • endDate
          DateTimeType endDate
          The date when the state ended.
        • milestone
          CodeableConcept milestone
          The milestones the subject has passed through.
        • reason
          CodeableConcept reason
          The reason for the state change. If coded it should follow the formal subject state model.
        • startDate
          DateTimeType startDate
          The date when the new status started.
        • subjectState
          CodeableConcept subjectState
          The current state of the subject.
        • type
          CodeableConcept type
          Identifies the aspect of the subject's journey that the state refers to.

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

      class Resource extends BaseResource implements Serializable
      serialVersionUID:
      -559462759L

      • Serialized Fields

        • id
          IdType id
          The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
        • implicitRules
          UriType implicitRules
          A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
        • language
          CodeType language
          The base language in which the resource is written.
        • meta
          Meta meta
          The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
        • sourcePackage
          PackageInformation sourcePackage
        • webPath
          String webPath

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

      class RiskAssessment extends DomainResource implements Serializable
      serialVersionUID:
      1076114228L

      • Serialized Fields

        • basedOn
          Reference basedOn
          A reference to the request that is fulfilled by this risk assessment.
        • basis
          List<Reference> basis
          Indicates the source data considered as part of the assessment (for example, FamilyHistory, Observations, Procedures, Conditions, etc.).
        • code
          CodeableConcept code
          The type of the risk assessment performed.
        • condition
          Reference condition
          For assessments or prognosis specific to a particular condition, indicates the condition being assessed.
        • encounter
          Reference encounter
          The encounter where the assessment was performed.
        • identifier
          List<Identifier> identifier
          Business identifier assigned to the risk assessment.
        • method
          CodeableConcept method
          The algorithm, process or mechanism used to evaluate the risk.
        • mitigation
          StringType mitigation
          A description of the steps that might be taken to reduce the identified risk(s).
        • note
          List<Annotation> note
          Additional comments about the risk assessment.
        • occurrence
          DataType occurrence
          The date (and possibly time) the risk assessment was performed.
        • parent
          Reference parent
          A reference to a resource that this risk assessment is part of, such as a Procedure.
        • performer
          Reference performer
          The provider, patient, related person, or software application that performed the assessment.
        • prediction
          List<RiskAssessment.RiskAssessmentPredictionComponent> prediction
          Describes the expected outcome for the subject.
        • reason
          List<CodeableReference> reason
          The reason the risk assessment was performed.
        • status
          Enumeration<Enumerations.ObservationStatus> status
          The status of the RiskAssessment, using the same statuses as an Observation.
        • subject
          Reference subject
          The patient or group the risk assessment applies to.

    • Class org.hl7.fhir.r5.model.RiskAssessment.RiskAssessmentPredictionComponent

      class RiskAssessmentPredictionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1559504257L

      • Serialized Fields

        • outcome
          CodeableConcept outcome
          One of the potential outcomes for the patient (e.g. remission, death, a particular condition).
        • probability
          DataType probability
          Indicates how likely the outcome is (in the specified timeframe).
        • qualitativeRisk
          CodeableConcept qualitativeRisk
          Indicates how likely the outcome is (in the specified timeframe), expressed as a qualitative value (e.g. low, medium, or high).
        • rationale
          StringType rationale
          Additional information explaining the basis for the prediction.
        • relativeRisk
          DecimalType relativeRisk
          Indicates the risk for this particular subject (with their specific characteristics) divided by the risk of the population in general. (Numbers greater than 1 = higher risk than the population, numbers less than 1 = lower risk.).
        • when
          DataType when
          Indicates the period of time or age range of the subject to which the specified probability applies.

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

      class SampledData extends DataType implements Serializable
      serialVersionUID:
      1859118926L

      • Serialized Fields

        • codeMap
          CanonicalType codeMap
          Reference to ConceptMap that defines the codes used in the data.
        • data
          StringType data
          A series of data points which are decimal values or codes separated by a single space (character u20). The special codes "E" (error), "L" (below detection limit) and "U" (above detection limit) are also defined for used in place of decimal values.
        • dimensions
          PositiveIntType dimensions
          The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.
        • factor
          DecimalType factor
          A correction factor that is applied to the sampled data points before they are added to the origin.
        • interval
          DecimalType interval
          Amount of intervalUnits between samples, e.g. milliseconds for time-based sampling.
        • intervalUnit
          CodeType intervalUnit
          The measurement unit in which the sample interval is expressed.
        • lowerLimit
          DecimalType lowerLimit
          The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).
        • offsets
          StringType offsets
          A series of data points which are decimal values separated by a single space (character u20). The units in which the offsets are expressed are found in intervalUnit. The absolute point at which the measurements begin SHALL be conveyed outside the scope of this datatype, e.g. Observation.effectiveDateTime for a timing offset.
        • origin
          Quantity origin
          The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series.
        • upperLimit
          DecimalType upperLimit
          The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).

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

      class Schedule extends DomainResource implements Serializable
      serialVersionUID:
      -370559713L

      • Serialized Fields

        • active
          BooleanType active
          Whether this schedule record is in active use or should not be used (such as was entered in error).
        • actor
          List<Reference> actor
          Slots that reference this schedule resource provide the availability details to these referenced resource(s).
        • comment
          MarkdownType comment
          Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.
        • identifier
          List<Identifier> identifier
          External Ids for this item.
        • name
          StringType name
          Further description of the schedule as it would be presented to a consumer while searching.
        • planningHorizon
          Period planningHorizon
          The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates.
        • serviceCategory
          List<CodeableConcept> serviceCategory
          A broad categorization of the service that is to be performed during this appointment.
        • serviceType
          List<CodeableReference> serviceType
          The specific service that is to be performed during this appointment.
        • specialty
          List<CodeableConcept> specialty
          The specialty of a practitioner that would be required to perform the service requested in this appointment.

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

      class SearchParameter extends CanonicalResource implements Serializable
      serialVersionUID:
      -327665794L

      • Serialized Fields

        • base
          List<Enumeration<Enumerations.VersionIndependentResourceTypesAll>> base
          The base resource type(s) that this search parameter can be used against.
        • chain
          List<StringType> chain
          Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.
        • code
          CodeType code
          The label that is recommended to be used in the URL or the parameter name in a parameters resource for this search parameter. In some cases, servers may need to use a different CapabilityStatement searchParam.name to differentiate between multiple SearchParameters that happen to have the same code.
        • comparator
          List<Enumeration<Enumerations.SearchComparator>> comparator
          Comparators supported for the search parameter.
        • component
          List<SearchParameter.SearchParameterComponentComponent> component
          Used to define the parts of a composite search parameter.
        • constraint
          StringType constraint
          FHIRPath expression that defines/sets a complex constraint for when this SearchParameter is applicable.
        • 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 search parameter and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the search parameter.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the search parameter was last significantly changed. 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 search parameter changes.
        • derivedFrom
          CanonicalType derivedFrom
          Where this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. i.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter.
        • description
          MarkdownType description
          And how it used.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        • expression
          StringType expression
          A FHIRPath expression that returns a set of elements for the search parameter.
        • identifier
          List<Identifier> identifier
          A formal identifier that is used to identify this search parameter 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 search parameter is intended to be used.
        • modifier
          List<Enumeration<Enumerations.SearchModifierCode>> modifier
          A modifier supported for the search parameter.
        • multipleAnd
          BooleanType multipleAnd
          Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.
        • multipleOr
          BooleanType multipleOr
          Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match.
        • name
          StringType name
          A natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • processingMode
          Enumeration<SearchParameter.SearchProcessingModeType> processingMode
          How the search parameter relates to the set of elements returned by evaluating the expression query.
        • publisher
          StringType publisher
          The name of the organization or individual tresponsible for the release and ongoing maintenance of the search parameter.
        • purpose
          MarkdownType purpose
          Explanation of why this search parameter is needed and why it has been designed as it has.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this search parameter. Enables tracking the life-cycle of the content.
        • target
          List<Enumeration<Enumerations.VersionIndependentResourceTypesAll>> target
          Types of resource (if a resource is referenced).
        • title
          StringType title
          A short, descriptive, user-friendly title for the search parameter.
        • type
          Enumeration<Enumerations.SearchParamType> type
          The type of value that a search parameter may contain, and how the content is interpreted.
        • url
          UriType url
          An absolute URI that is used to identify this search parameter 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 an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter 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 search parameter instances.
        • version
          StringType version
          The identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • Class org.hl7.fhir.r5.model.SearchParameter.SearchParameterComponentComponent

      class SearchParameterComponentComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1469435618L

      • Serialized Fields

        • definition
          CanonicalType definition
          The definition of the search parameter that describes this part.
        • expression
          StringType expression
          A sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expression.

    • Class org.hl7.fhir.r5.model.SearchParameter.SearchProcessingModeTypeEnumFactory

      class SearchProcessingModeTypeEnumFactory extends Object implements Serializable

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

      class ServiceRequest extends DomainResource implements Serializable
      serialVersionUID:
      -1785672942L

      • Serialized Fields

        • asNeeded
          DataType asNeeded
          If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.
        • authoredOn
          DateTimeType authoredOn
          When the request transitioned to being actionable.
        • basedOn
          List<Reference> basedOn
          Plan/proposal/order fulfilled by this request.
        • bodySite
          List<CodeableConcept> bodySite
          Anatomic location where the procedure should be performed. This is the target site.
        • bodyStructure
          Reference bodyStructure
          Anatomic location where the procedure should be performed. This is the target site.
        • category
          List<CodeableConcept> category
          A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").
        • code
          CodeableReference code
          A code or reference that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.
        • doNotPerform
          BooleanType doNotPerform
          Set this to true if the record is saying that the service/procedure should NOT be performed.
        • encounter
          Reference encounter
          An encounter that provides additional information about the healthcare context in which this request is made.
        • focus
          List<Reference> focus
          The actual focus of a service request when it is not the subject of record representing something or someone associated with the subject such as a spouse, parent, fetus, or donor. The focus of a service request could also be an existing condition, an intervention, the subject's diet, another service request on the subject, or a body structure such as tumor or implanted device.
        • identifier
          List<Identifier> identifier
          Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
        • instantiatesCanonical
          List<CanonicalType> instantiatesCanonical
          The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.
        • instantiatesUri
          List<UriType> instantiatesUri
          The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.
        • insurance
          List<Reference> insurance
          Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.
        • intent
          Enumeration<Enumerations.RequestIntent> intent
          Whether the request is a proposal, plan, an original order or a reflex order.
        • location
          List<CodeableReference> location
          The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center.
        • note
          List<Annotation> note
          Any other notes and comments made about the service request. For example, internal billing notes.
        • occurrence
          DataType occurrence
          The date/time at which the requested service should occur.
        • orderDetail
          List<ServiceRequest.ServiceRequestOrderDetailComponent> orderDetail
          Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied.
        • patientInstruction
          List<ServiceRequest.ServiceRequestPatientInstructionComponent> patientInstruction
          Instructions in terms that are understood by the patient or consumer.
        • performer
          List<Reference> performer
          The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.
        • performerType
          CodeableConcept performerType
          Desired type of performer for doing the requested service.
        • priority
          Enumeration<Enumerations.RequestPriority> priority
          Indicates how quickly the ServiceRequest should be addressed with respect to other requests.
        • quantity
          DataType quantity
          An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).
        • reason
          List<CodeableReference> reason
          An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in `supportingInfo`.
        • relevantHistory
          List<Reference> relevantHistory
          Key events in the history of the request.
        • replaces
          List<Reference> replaces
          The request takes the place of the referenced completed or terminated request(s).
        • requester
          Reference requester
          The individual who initiated the request and has responsibility for its activation.
        • requisition
          Identifier requisition
          A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.
        • specimen
          List<Reference> specimen
          One or more specimens that the laboratory procedure will use.
        • status
          Enumeration<Enumerations.RequestStatus> status
          The status of the order.
        • subject
          Reference subject
          On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).
        • supportingInfo
          List<CodeableReference> supportingInfo
          Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.

    • Class org.hl7.fhir.r5.model.ServiceRequest.ServiceRequestOrderDetailComponent

      class ServiceRequestOrderDetailComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -404214439L

    • Class org.hl7.fhir.r5.model.ServiceRequest.ServiceRequestOrderDetailParameterComponent

      class ServiceRequestOrderDetailParameterComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1950789033L

      • Serialized Fields

        • code
          CodeableConcept code
          A value representing the additional detail or instructions for the order (e.g., catheter insertion, body elevation, descriptive device configuration and/or setting instructions).
        • value
          DataType value
          Indicates a value for the order detail.

    • Class org.hl7.fhir.r5.model.ServiceRequest.ServiceRequestPatientInstructionComponent

      class ServiceRequestPatientInstructionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      474568404L

      • Serialized Fields

        • instruction
          DataType instruction
          Instructions in terms that are understood by the patient or consumer.

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

      class SidType extends UriType implements Externalizable
      serialVersionUID:
      5486832330986493589L

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

      class Signature extends DataType implements Serializable
      serialVersionUID:
      -986223243L

      • Serialized Fields

        • data
          Base64BinaryType data
          The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.
        • onBehalfOf
          Reference onBehalfOf
          A reference to an application-usable description of the identity that is represented by the signature.
        • sigFormat
          CodeType sigFormat
          A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.
        • targetFormat
          CodeType targetFormat
          A mime type that indicates the technical format of the target resources signed by the signature.
        • type
          List<Coding> type
          An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.
        • when
          InstantType when
          When the digital signature was signed.
        • who
          Reference who
          A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).

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

      class SimpleQuantity extends Quantity implements Serializable
      serialVersionUID:
      1069574054L

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

      class Slot extends DomainResource implements Serializable
      serialVersionUID:
      2060370370L

      • Serialized Fields

        • appointmentType
          List<CodeableConcept> appointmentType
          The style of appointment or patient that may be booked in the slot (not service type).
        • comment
          StringType comment
          Comments on the slot to describe any extended information. Such as custom constraints on the slot.
        • end
          InstantType end
          Date/Time that the slot is to conclude.
        • identifier
          List<Identifier> identifier
          External Ids for this item.
        • overbooked
          BooleanType overbooked
          This slot has already been overbooked, appointments are unlikely to be accepted for this time.
        • schedule
          Reference schedule
          The schedule resource that this slot defines an interval of status information.
        • serviceCategory
          List<CodeableConcept> serviceCategory
          A broad categorization of the service that is to be performed during this appointment.
        • serviceType
          List<CodeableReference> serviceType
          The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the Schedule resource.
        • specialty
          List<CodeableConcept> specialty
          The specialty of a practitioner that would be required to perform the service requested in this appointment.
        • start
          InstantType start
          Date/Time that the slot is to begin.
        • status
          Enumeration<Slot.SlotStatus> status
          busy | free | busy-unavailable | busy-tentative | entered-in-error.

    • Class org.hl7.fhir.r5.model.Slot.SlotStatusEnumFactory

      class SlotStatusEnumFactory extends Object implements Serializable

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

      class Specimen extends DomainResource implements Serializable
      serialVersionUID:
      -445425000L

      • Serialized Fields

        • accessionIdentifier
          Identifier accessionIdentifier
          The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
        • collection
          Specimen.SpecimenCollectionComponent collection
          Details concerning the specimen collection.
        • combined
          Enumeration<Specimen.SpecimenCombined> combined
          This element signifies if the specimen is part of a group or pooled.
        • condition
          List<CodeableConcept> condition
          A mode or state of being that describes the nature of the specimen.
        • container
          List<Specimen.SpecimenContainerComponent> container
          The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.
        • feature
          List<Specimen.SpecimenFeatureComponent> feature
          A physical feature or landmark on a specimen, highlighted for context by the collector of the specimen (e.g. surgeon), that identifies the type of feature as well as its meaning (e.g. the red ink indicating the resection margin of the right lobe of the excised prostate tissue or wire loop at radiologically suspected tumor location).
        • identifier
          List<Identifier> identifier
          Id for specimen.
        • note
          List<Annotation> note
          To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).
        • parent
          List<Reference> parent
          Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
        • processing
          List<Specimen.SpecimenProcessingComponent> processing
          Details concerning processing and processing steps for the specimen.
        • receivedTime
          DateTimeType receivedTime
          Time when specimen is received by the testing laboratory for processing or testing.
        • request
          List<Reference> request
          Details concerning a service request that required a specimen to be collected.
        • role
          List<CodeableConcept> role
          The role or reason for the specimen in the testing workflow.
        • status
          Enumeration<Specimen.SpecimenStatus> status
          The availability of the specimen.
        • subject
          Reference subject
          Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance, a biologically-derived product, or a device.
        • type
          CodeableConcept type
          The kind of material that forms the specimen.

    • Class org.hl7.fhir.r5.model.Specimen.SpecimenCollectionComponent

      class SpecimenCollectionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      953983070L

      • Serialized Fields

        • bodySite
          CodeableReference bodySite
          Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.
        • collected
          DataType collected
          Time when specimen was collected from subject - the physiologically relevant time.
        • collector
          Reference collector
          Person who collected the specimen.
        • device
          CodeableReference device
          A coded value specifying the technique that is used to perform the procedure.
        • duration
          Duration duration
          The span of time over which the collection of a specimen occurred.
        • fastingStatus
          DataType fastingStatus
          Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.
        • method
          CodeableConcept method
          A coded value specifying the technique that is used to perform the procedure.
        • procedure
          Reference procedure
          The procedure event during which the specimen was collected (e.g. the surgery leading to the collection of a pathology sample).
        • quantity
          Quantity quantity
          The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.

    • Class org.hl7.fhir.r5.model.Specimen.SpecimenCombinedEnumFactory

      class SpecimenCombinedEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Specimen.SpecimenContainerComponent

      class SpecimenContainerComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1973387427L

      • Serialized Fields

        • device
          Reference device
          The device resource for the the container holding the specimen. If the container is in a holder then the referenced device will point to a parent device.
        • location
          Reference location
          The location of the container holding the specimen.
        • specimenQuantity
          Quantity specimenQuantity
          The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.

    • Class org.hl7.fhir.r5.model.Specimen.SpecimenFeatureComponent

      class SpecimenFeatureComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1762224562L

      • Serialized Fields

        • description
          StringType description
          Description of the feature of the specimen.
        • type
          CodeableConcept type
          The landmark or feature being highlighted.

    • Class org.hl7.fhir.r5.model.Specimen.SpecimenProcessingComponent

      class SpecimenProcessingComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -329044827L

      • Serialized Fields

        • additive
          List<Reference> additive
          Material used in the processing step.
        • description
          StringType description
          Textual description of procedure.
        • method
          CodeableConcept method
          A coded value specifying the method used to process the specimen.
        • time
          DataType time
          A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin.

    • Class org.hl7.fhir.r5.model.Specimen.SpecimenStatusEnumFactory

      class SpecimenStatusEnumFactory extends Object implements Serializable

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

      class SpecimenDefinition extends DomainResource implements Serializable
      serialVersionUID:
      1698015458L

      • Serialized Fields

        • approvalDate
          DateType approvalDate
          The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.
        • collection
          List<CodeableConcept> collection
          The action to be performed for collecting the specimen.
        • contact
          List<ContactDetail> contact
          Contact details to assist a user in finding and communicating with the publisher.
        • copyright
          MarkdownType copyright
          Copyright statement relating to the SpecimenDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SpecimenDefinition.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.
        • derivedFromCanonical
          List<CanonicalType> derivedFromCanonical
          The canonical URL pointing to another FHIR-defined SpecimenDefinition that is adhered to in whole or in part by this definition.
        • derivedFromUri
          List<UriType> derivedFromUri
          The URL pointing to an externally-defined type of specimen, guideline or other definition that is adhered to in whole or in part by this definition.
        • description
          MarkdownType description
          A free text natural language description of the SpecimenDefinition from the consumer's perspective.
        • effectivePeriod
          Period effectivePeriod
          The period during which the SpecimenDefinition content was or is planned to be effective.
        • experimental
          BooleanType experimental
          A flag to indicate that this SpecimenDefinition is not authored for genuine usage.
        • identifier
          Identifier identifier
          A business identifier assigned to this SpecimenDefinition.
        • jurisdiction
          List<CodeableConcept> jurisdiction
          A jurisdiction in which the SpecimenDefinition is intended to be used.
        • lastReviewDate
          DateType lastReviewDate
          The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.
        • name
          StringType name
          A natural language name identifying the specimen definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • patientPreparation
          List<CodeableConcept> patientPreparation
          Preparation of the patient for specimen collection.
        • publisher
          StringType publisher
          Helps establish the "authority/credibility" of the SpecimenDefinition. May also allow for contact.
        • purpose
          MarkdownType purpose
          Explains why this SpecimeDefinition is needed and why it has been designed as it has.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The current state of theSpecimenDefinition.
        • subject
          DataType subject
          A code or group definition that describes the intended subject from which this kind of specimen is to be collected.
        • timeAspect
          StringType timeAspect
          Time aspect of specimen collection (duration or offset).
        • title
          StringType title
          A short, descriptive, user-friendly title for the SpecimenDefinition.
        • typeCollected
          CodeableConcept typeCollected
          The kind of material to be collected.
        • typeTested
          List<SpecimenDefinition.SpecimenDefinitionTypeTestedComponent> typeTested
          Specimen conditioned in a container as expected by the testing laboratory.
        • url
          UriType url
          An absolute URL that is used to identify this SpecimenDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this SpecimenDefinition is (or will be) published. The URL SHOULD include the major version of the SpecimenDefinition. For more information see Technical and Business Versions.
        • useContext
          List<UsageContext> useContext
          The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of specimen definitions.
        • version
          StringType version
          The identifier that is used to identify this version of the SpecimenDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the SpecimenDefinition author and is not expected to be globally unique.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • Class org.hl7.fhir.r5.model.SpecimenDefinition.SpecimenContainedPreferenceEnumFactory

      class SpecimenContainedPreferenceEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.SpecimenDefinition.SpecimenDefinitionTypeTestedComponent

      class SpecimenDefinitionTypeTestedComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -609761988L

    • Class org.hl7.fhir.r5.model.SpecimenDefinition.SpecimenDefinitionTypeTestedContainerAdditiveComponent

      class SpecimenDefinitionTypeTestedContainerAdditiveComponent extends BackboneElement implements Serializable
      serialVersionUID:
      201856258L

      • Serialized Fields

        • additive
          DataType additive
          Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.

    • Class org.hl7.fhir.r5.model.SpecimenDefinition.SpecimenDefinitionTypeTestedContainerComponent

      class SpecimenDefinitionTypeTestedContainerComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -932984420L

      • Serialized Fields

        • additive
          List<SpecimenDefinition.SpecimenDefinitionTypeTestedContainerAdditiveComponent> additive
          Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.
        • cap
          CodeableConcept cap
          Color of container cap.
        • capacity
          Quantity capacity
          The capacity (volume or other measure) of this kind of container.
        • description
          MarkdownType description
          The textual description of the kind of container.
        • material
          CodeableConcept material
          The type of material of the container.
        • minimumVolume
          DataType minimumVolume
          The minimum volume to be conditioned in the container.
        • preparation
          MarkdownType preparation
          Special processing that should be applied to the container for this kind of specimen.
        • type
          CodeableConcept type
          The type of container used to contain this kind of specimen.

    • Class org.hl7.fhir.r5.model.SpecimenDefinition.SpecimenDefinitionTypeTestedHandlingComponent

      class SpecimenDefinitionTypeTestedHandlingComponent extends BackboneElement implements Serializable
      serialVersionUID:
      113016318L

      • Serialized Fields

        • instruction
          MarkdownType instruction
          Additional textual instructions for the preservation or transport of the specimen. For instance, 'Protect from light exposure'.
        • maxDuration
          Duration maxDuration
          The maximum time interval of preservation of the specimen with these conditions.
        • temperatureQualifier
          CodeableConcept temperatureQualifier
          It qualifies the interval of temperature, which characterizes an occurrence of handling. Conditions that are not related to temperature may be handled in the instruction element.
        • temperatureRange
          Range temperatureRange
          The temperature interval for this set of handling instructions.

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

      class Statistic extends BackboneType implements Serializable
      serialVersionUID:
      -1861373489L

      • Serialized Fields

        • attributeEstimate
          List<Statistic.StatisticAttributeEstimateComponent> attributeEstimate
          A statistical attribute of the statistic such as a measure of heterogeneity.
        • category
          CodeableConcept category
          When the measured variable is handled categorically, the category element is used to define which category the statistic is reporting.
        • description
          StringType description
          A description of the content value of the statistic.
        • modelCharacteristic
          List<Statistic.StatisticModelCharacteristicComponent> modelCharacteristic
          A component of the method to generate the statistic.
        • note
          List<Annotation> note
          Footnotes and/or explanatory notes.
        • numberAffected
          UnsignedIntType numberAffected
          The number of participants affected where the unit of analysis is the same as sampleSize.knownDataCount and sampleSize.numberOfParticipants.
        • numberOfEvents
          UnsignedIntType numberOfEvents
          The number of events associated with the statistic, where the unit of analysis is different from numberAffected, sampleSize.knownDataCount and sampleSize.numberOfParticipants.
        • quantity
          Quantity quantity
          Statistic value.
        • sampleSize
          Statistic.StatisticSampleSizeComponent sampleSize
          Number of samples in the statistic.
        • statisticType
          CodeableConcept statisticType
          Type of statistic, eg relative risk.

    • Class org.hl7.fhir.r5.model.Statistic.StatisticAttributeEstimateAttributeEstimateComponent

      class StatisticAttributeEstimateAttributeEstimateComponent extends Element implements Serializable
      serialVersionUID:
      1873606362L

      • Serialized Fields

        • description
          StringType description
          Human-readable summary of the estimate.
        • level
          DecimalType level
          Use 95 for a 95% confidence interval.
        • note
          List<Annotation> note
          Footnote or explanatory note about the estimate.
        • quantity
          Quantity quantity
          The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure.
        • range
          Range range
          Lower bound of confidence interval.
        • type
          CodeableConcept type
          The type of attribute estimate, eg confidence interval or p value.

    • Class org.hl7.fhir.r5.model.Statistic.StatisticAttributeEstimateComponent

      class StatisticAttributeEstimateComponent extends Element implements Serializable
      serialVersionUID:
      2062805621L

      • Serialized Fields

        • attributeEstimate
          List<Statistic.StatisticAttributeEstimateAttributeEstimateComponent> attributeEstimate
          A nested attribute estimate; which is the attribute estimate of an attribute estimate.
        • description
          StringType description
          Human-readable summary of the estimate.
        • level
          DecimalType level
          Use 95 for a 95% confidence interval.
        • note
          List<Annotation> note
          Footnote or explanatory note about the estimate.
        • quantity
          Quantity quantity
          The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure.
        • range
          Range range
          Lower bound of confidence interval.
        • type
          CodeableConcept type
          The type of attribute estimate, eg confidence interval or p value.

    • Class org.hl7.fhir.r5.model.Statistic.StatisticModelCharacteristicComponent

      class StatisticModelCharacteristicComponent extends Element implements Serializable
      serialVersionUID:
      1539071113L

    • Class org.hl7.fhir.r5.model.Statistic.StatisticModelCharacteristicVariableComponent

      class StatisticModelCharacteristicVariableComponent extends Element implements Serializable
      serialVersionUID:
      1516174900L

      • Serialized Fields

        • handling
          Enumeration<Enumerations.EvidenceVariableHandling> handling
          How the variable is classified for use in adjusted analysis.
        • valueCategory
          List<CodeableConcept> valueCategory
          Description for grouping of ordinal or polychotomous variables.
        • valueQuantity
          List<Quantity> valueQuantity
          Discrete value for grouping of ordinal or polychotomous variables.
        • valueRange
          List<Range> valueRange
          Range of values for grouping of ordinal or polychotomous variables.
        • variableDefinition
          Reference variableDefinition
          Description of the variable.

    • Class org.hl7.fhir.r5.model.Statistic.StatisticSampleSizeComponent

      class StatisticSampleSizeComponent extends Element implements Serializable
      serialVersionUID:
      -1870635979L

      • Serialized Fields

        • description
          StringType description
          Human-readable summary of population sample size.
        • knownDataCount
          UnsignedIntType knownDataCount
          Number of participants with known results for measured variables.
        • note
          List<Annotation> note
          Footnote or explanatory note about the sample size.
        • numberOfParticipants
          UnsignedIntType numberOfParticipants
          A human-readable string to clarify or explain concepts about the sample size.
        • numberOfStudies
          UnsignedIntType numberOfStudies
          Number of participants in the population.

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

      class StringType extends PrimitiveType<String> implements Externalizable
      serialVersionUID:
      3L

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

      class StructureDefinition extends CanonicalResource implements Serializable
      serialVersionUID:
      -1127285723L

      • Serialized Fields

        • abstract_
          BooleanType abstract_
          Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.
        • baseDefinition
          CanonicalType baseDefinition
          An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.
        • contact
          List<ContactDetail> contact
          Contact details to assist a user in finding and communicating with the publisher.
        • context
          List<StructureDefinition.StructureDefinitionContextComponent> context
          Identifies the types of resource or data type elements to which the extension can be applied. For more guidance on using the 'context' element, see the [defining extensions page](defining-extensions.html#context).
        • contextInvariant
          List<StringType> contextInvariant
          A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true.
        • copyright
          MarkdownType copyright
          A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure definition. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the structure definition was last significantly changed. 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 structure definition changes.
        • derivation
          Enumeration<StructureDefinition.TypeDerivationRule> derivation
          How the type relates to the baseDefinition.
        • description
          MarkdownType description
          A free text natural language description of the structure definition from a consumer's perspective.
        • differential
          StructureDefinition.StructureDefinitionDifferentialComponent differential
          A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this structure definition 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 on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.6.0. for this version.
        • generatedSnapshot
          boolean generatedSnapshot
        • generatingSnapshot
          boolean generatingSnapshot
        • identifier
          List<Identifier> identifier
          A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
        • jurisdiction
          List<CodeableConcept> jurisdiction
          A legal or geographic region in which the structure definition is intended to be used.
        • keyword
          List<Coding> keyword
          (DEPRECATED) A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates nby describing the use of this structure definition, or the content it describes.
        • kind
          Enumeration<StructureDefinition.StructureDefinitionKind> kind
          Defines the kind of structure that this definition is describing.
        • mapping
          List<StructureDefinition.StructureDefinitionMappingComponent> mapping
          An external specification that the content is mapped to.
        • name
          StringType name
          A natural language name identifying the structure 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 responsible for the release and ongoing maintenance of the structure definition.
        • purpose
          MarkdownType purpose
          Explanation of why this structure definition is needed and why it has been designed as it has.
        • snapshot
          StructureDefinition.StructureDefinitionSnapshotComponent snapshot
          A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this structure definition. Enables tracking the life-cycle of the content.
        • title
          StringType title
          A short, descriptive, user-friendly title for the structure definition.
        • type
          UriType type
          The type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type). References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. "string" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models, where they are required.
        • url
          UriType url
          An absolute URI that is used to identify this structure 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 an authoritative instance of this structure definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure 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 structure definition instances.
        • version
          StringType version
          The identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition author and is not expected to be globally unique. There is no expectation that versions can be placed in a lexicographical sequence, so authors are encouraged to populate the StructureDefinition.versionAlgorithm[x] element to enable comparisons. If there is no managed version available, authors can consider using ISO date/time syntax (e.g., '2023-01-01').
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • Class org.hl7.fhir.r5.model.StructureDefinition.ExtensionContextTypeEnumFactory

      class ExtensionContextTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.StructureDefinition.StructureDefinitionContextComponent

      class StructureDefinitionContextComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1958074856L

    • Class org.hl7.fhir.r5.model.StructureDefinition.StructureDefinitionDifferentialComponent

      class StructureDefinitionDifferentialComponent extends BackboneElement implements Serializable
      serialVersionUID:
      53896641L

      • Serialized Fields

    • Class org.hl7.fhir.r5.model.StructureDefinition.StructureDefinitionKindEnumFactory

      class StructureDefinitionKindEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.StructureDefinition.StructureDefinitionMappingComponent

      class StructureDefinitionMappingComponent extends BackboneElement implements Serializable
      serialVersionUID:
      9610265L

      • Serialized Fields

        • comment
          StringType comment
          Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.
        • identity
          IdType identity
          An Internal id that is used to identify this mapping set when specific mappings are made.
        • name
          StringType name
          A name for the specification that is being mapped to.
        • uri
          UriType uri
          An absolute URI that identifies the specification that this mapping is expressed to.

    • Class org.hl7.fhir.r5.model.StructureDefinition.StructureDefinitionSnapshotComponent

      class StructureDefinitionSnapshotComponent extends BackboneElement implements Serializable
      serialVersionUID:
      53896641L

      • Serialized Fields

    • Class org.hl7.fhir.r5.model.StructureDefinition.TypeDerivationRuleEnumFactory

      class TypeDerivationRuleEnumFactory extends Object implements Serializable

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

      class StructureMap extends CanonicalResource implements Serializable
      serialVersionUID:
      -1875777589L

      • Serialized Fields

        • const_
          List<StructureMap.StructureMapConstComponent> const_
          Definition of a constant value used in the map rules.
        • 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 structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure map.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the structure map was last significantly changed. 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 structure map changes.
        • description
          MarkdownType description
          A free text natural language description of the structure map from a consumer's perspective.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this structure map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        • group
          List<StructureMap.StructureMapGroupComponent> group
          Organizes the mapping into managable chunks for human review/ease of maintenance.
        • identifier
          List<Identifier> identifier
          A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instance.
        • import_
          List<CanonicalType> import_
          Other maps used by this map (canonical URLs).
        • jurisdiction
          List<CodeableConcept> jurisdiction
          A legal or geographic region in which the structure map is intended to be used.
        • name
          StringType name
          A natural language name identifying the structure 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 responsible for the release and ongoing maintenance of the structure map.
        • purpose
          MarkdownType purpose
          Explanation of why this structure map is needed and why it has been designed as it has.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this structure map. Enables tracking the life-cycle of the content.
        • structure
          List<StructureMap.StructureMapStructureComponent> structure
          A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.
        • title
          StringType title
          A short, descriptive, user-friendly title for the structure map.
        • url
          UriType url
          An absolute URI that is used to identify this structure 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 an authoritative instance of this structure map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure 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 structure map instances.
        • version
          StringType version
          The identifier that is used to identify this version of the structure map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • Class org.hl7.fhir.r5.model.StructureMap.StructureMapConstComponent

      class StructureMapConstComponent extends BackboneElement implements Serializable
      serialVersionUID:
      19170614L

      • Serialized Fields

        • name
          IdType name
          Other maps used by this map (canonical URLs).
        • value
          StringType value
          A FHIRPath expression that is the value of this variable.

    • Class org.hl7.fhir.r5.model.StructureMap.StructureMapGroupComponent

      class StructureMapGroupComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1474595081L

    • Class org.hl7.fhir.r5.model.StructureMap.StructureMapGroupInputComponent

      class StructureMapGroupInputComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -25050724L

    • Class org.hl7.fhir.r5.model.StructureMap.StructureMapGroupRuleComponent

      class StructureMapGroupRuleComponent extends BackboneElement implements Serializable
      serialVersionUID:
      773925517L

    • Class org.hl7.fhir.r5.model.StructureMap.StructureMapGroupRuleDependentComponent

      class StructureMapGroupRuleDependentComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -290346576L

    • Class org.hl7.fhir.r5.model.StructureMap.StructureMapGroupRuleSourceComponent

      class StructureMapGroupRuleSourceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      214178119L

      • Serialized Fields

        • check
          StringType check
          FHIRPath expression - must be true or the mapping engine throws an error instead of completing.
        • condition
          StringType condition
          FHIRPath expression - must be true or the rule does not apply.
        • context
          IdType context
          Type or variable this rule applies to.
        • defaultValue
          StringType defaultValue
          A value to use if there is no existing value in the source object.
        • element
          StringType element
          Optional field for this source.
        • listMode
          Enumeration<StructureMap.StructureMapSourceListMode> listMode
          How to handle the list mode for this element.
        • logMessage
          StringType logMessage
          A FHIRPath expression which specifies a message to put in the transform log when content matching the source rule is found.
        • max
          StringType max
          Specified maximum cardinality for the element - a number or a "*". This is optional; if present, it acts an implicit check on the input content (* just serves as documentation; it's the default value).
        • min
          IntegerType min
          Specified minimum cardinality for the element. This is optional; if present, it acts an implicit check on the input content.
        • type
          StringType type
          Specified type for the element. This works as a condition on the mapping - use for polymorphic elements.
        • variable
          IdType variable
          Named context for field, if a field is specified.

    • Class org.hl7.fhir.r5.model.StructureMap.StructureMapGroupRuleTargetComponent

      class StructureMapGroupRuleTargetComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1565495071L

    • Class org.hl7.fhir.r5.model.StructureMap.StructureMapGroupRuleTargetParameterComponent

      class StructureMapGroupRuleTargetParameterComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1135414639L

      • Serialized Fields

        • value
          DataType value
          Parameter value - variable or literal.

    • Class org.hl7.fhir.r5.model.StructureMap.StructureMapGroupTypeModeEnumFactory

      class StructureMapGroupTypeModeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.StructureMap.StructureMapInputModeEnumFactory

      class StructureMapInputModeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.StructureMap.StructureMapModelModeEnumFactory

      class StructureMapModelModeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.StructureMap.StructureMapSourceListModeEnumFactory

      class StructureMapSourceListModeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.StructureMap.StructureMapStructureComponent

      class StructureMapStructureComponent extends BackboneElement implements Serializable
      serialVersionUID:
      364750586L

    • Class org.hl7.fhir.r5.model.StructureMap.StructureMapTargetListModeEnumFactory

      class StructureMapTargetListModeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.StructureMap.StructureMapTransformEnumFactory

      class StructureMapTransformEnumFactory extends Object implements Serializable

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

      class Subscription extends DomainResource implements Serializable
      serialVersionUID:
      1396960420L

      • Serialized Fields

        • channelType
          Coding channelType
          The type of channel to send notifications on.
        • contact
          List<ContactPoint> contact
          Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
        • content
          Enumeration<Subscription.SubscriptionPayloadContent> content
          How much of the resource content to deliver in the notification payload. The choices are an empty payload, only the resource id, or the full resource content.
        • contentType
          CodeType contentType
          The MIME type to send the payload in - e.g., `application/fhir+xml` or `application/fhir+json`. Note that: clients may request notifications in a specific FHIR version by using the [FHIR Version Parameter](http.html#version-parameter) - e.g., `application/fhir+json; fhirVersion=4.0`. additional MIME types can be allowed by channels - e.g., `text/plain` and `text/html` are defined by the Email channel.
        • end
          InstantType end
          The time for the server to turn the subscription off.
        • endpoint
          UrlType endpoint
          The url that describes the actual end-point to send notifications to.
        • filterBy
          List<Subscription.SubscriptionFilterByComponent> filterBy
          The filter properties to be applied to narrow the subscription topic stream. When multiple filters are applied, evaluates to true if all the conditions applicable to that resource are met; otherwise it returns false (i.e., logical AND).
        • heartbeatPeriod
          UnsignedIntType heartbeatPeriod
          If present, a 'heartbeat' notification (keep-alive) is sent via this channel with an interval period equal to this elements integer value in seconds. If not present, a heartbeat notification is not sent.
        • 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.
        • managingEntity
          Reference managingEntity
          Entity with authorization to make subsequent revisions to the Subscription and also determines what data the subscription is authorized to disclose.
        • maxCount
          PositiveIntType maxCount
          If present, the maximum number of events that will be included in a notification bundle. Note that this is not a strict limit on the number of entries in a bundle, as dependent resources can be included.
        • name
          StringType name
          A natural language name identifying the subscription.
        • parameter
          List<Subscription.SubscriptionParameterComponent> parameter
          Channel-dependent information to send as part of the notification (e.g., HTTP Headers).
        • reason
          StringType reason
          A description of why this subscription is defined.
        • status
          Enumeration<Enumerations.SubscriptionStatusCodes> status
          The status of the subscription, which marks the server state for managing the subscription.
        • timeout
          UnsignedIntType timeout
          If present, the maximum amount of time a server will allow before failing a notification attempt.
        • topic
          CanonicalType topic
          The reference to the subscription topic to be notified about.

    • Class org.hl7.fhir.r5.model.Subscription.SubscriptionFilterByComponent

      class SubscriptionFilterByComponent extends BackboneElement implements Serializable
      serialVersionUID:
      765605139L

      • Serialized Fields

        • comparator
          Enumeration<Enumerations.SearchComparator> comparator
          Comparator applied to this filter parameter.
        • filterParameter
          StringType filterParameter
          The filter as defined in the `SubscriptionTopic.canFilterBy.filterParameter` element.
        • modifier
          Enumeration<Enumerations.SearchModifierCode> modifier
          Modifier applied to this filter parameter.
        • resourceType
          UriType resourceType
          A resource listed in the `SubscriptionTopic` this `Subscription` references (`SubscriptionTopic.canFilterBy.resource`). This element can be used to differentiate filters for topics that include more than one resource type.
        • value
          StringType value
          The literal value or resource path as is legal in search - for example, `Patient/123` or `le1950`.

    • Class org.hl7.fhir.r5.model.Subscription.SubscriptionParameterComponent

      class SubscriptionParameterComponent extends BackboneElement implements Serializable
      serialVersionUID:
      395259392L

      • Serialized Fields

        • name
          StringType name
          Parameter name for information passed to the channel for notifications, for example in the case of a REST hook wanting to pass through an authorization header, the name would be Authorization.
        • value
          StringType value
          Parameter value for information passed to the channel for notifications, for example in the case of a REST hook wanting to pass through an authorization header, the value would be `Bearer 0193...`.

    • Class org.hl7.fhir.r5.model.Subscription.SubscriptionPayloadContentEnumFactory

      class SubscriptionPayloadContentEnumFactory extends Object implements Serializable

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

      class SubscriptionStatus extends DomainResource implements Serializable
      serialVersionUID:
      -285503955L

      • Serialized Fields

        • error
          List<CodeableConcept> error
          A record of errors that occurred when the server processed a notification.
        • eventsSinceSubscriptionStart
          Integer64Type eventsSinceSubscriptionStart
          The total number of actual events which have been generated since the Subscription was created (inclusive of this notification) - regardless of how many have been successfully communicated. This number is NOT incremented for handshake and heartbeat notifications.
        • notificationEvent
          List<SubscriptionStatus.SubscriptionStatusNotificationEventComponent> notificationEvent
          Detailed information about events relevant to this subscription notification.
        • status
          Enumeration<Enumerations.SubscriptionStatusCodes> status
          The status of the subscription, which marks the server state for managing the subscription.
        • subscription
          Reference subscription
          The reference to the Subscription which generated this notification.
        • topic
          CanonicalType topic
          The reference to the SubscriptionTopic for the Subscription which generated this notification.
        • type
          Enumeration<SubscriptionStatus.SubscriptionNotificationType> type
          The type of event being conveyed with this notification.

    • Class org.hl7.fhir.r5.model.SubscriptionStatus.SubscriptionNotificationTypeEnumFactory

      class SubscriptionNotificationTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.SubscriptionStatus.SubscriptionStatusNotificationEventComponent

      class SubscriptionStatusNotificationEventComponent extends BackboneElement implements Serializable
      serialVersionUID:
      855121922L

      • Serialized Fields

        • additionalContext
          List<Reference> additionalContext
          Additional context information for this event. Generally, this will contain references to additional resources included with the event (e.g., the Patient relevant to an Encounter), however it MAY refer to non-FHIR objects.
        • eventNumber
          Integer64Type eventNumber
          Either the sequential number of this event in this subscription context or a relative event number for this notification.
        • focus
          Reference focus
          The focus of this event. While this will usually be a reference to the focus resource of the event, it MAY contain a reference to a non-FHIR object.
        • timestamp
          InstantType timestamp
          The actual time this event occurred on the server.

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

      class SubscriptionTopic extends CanonicalResource implements Serializable
      serialVersionUID:
      -194061063L

      • Serialized Fields

        • approvalDate
          DateType approvalDate
          The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.
        • canFilterBy
          List<SubscriptionTopic.SubscriptionTopicCanFilterByComponent> canFilterBy
          List of properties by which Subscriptions on the SubscriptionTopic can be filtered. May be defined Search Parameters (e.g., Encounter.patient) or parameters defined within this SubscriptionTopic context (e.g., hub.event).
        • 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 SubscriptionTopic and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SubscriptionTopic.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the subscription topic was last significantly changed. 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 subscription topic changes.
        • derivedFrom
          List<CanonicalType> derivedFrom
          The canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic.
        • description
          MarkdownType description
          A free text natural language description of the Topic from the consumer's perspective.
        • effectivePeriod
          Period effectivePeriod
          The period during which the SubscriptionTopic content was or is planned to be effective.
        • eventTrigger
          List<SubscriptionTopic.SubscriptionTopicEventTriggerComponent> eventTrigger
          Event definition which can be used to trigger the SubscriptionTopic.
        • experimental
          BooleanType experimental
          A flag to indicate that this TopSubscriptionTopicic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
        • identifier
          List<Identifier> identifier
          Business identifiers assigned to this subscription topic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.
        • jurisdiction
          List<CodeableConcept> jurisdiction
          A jurisdiction in which the Topic is intended to be used.
        • lastReviewDate
          DateType lastReviewDate
          The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.
        • name
          StringType name
          A natural language name identifying the subscription topic This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • notificationShape
          List<SubscriptionTopic.SubscriptionTopicNotificationShapeComponent> notificationShape
          List of properties to describe the shape (e.g., resources) included in notifications from this Subscription Topic.
        • publisher
          StringType publisher
          Helps establish the "authority/credibility" of the SubscriptionTopic. May also allow for contact.
        • purpose
          MarkdownType purpose
          Explains why this Topic is needed and why it has been designed as it has.
        • resourceTrigger
          List<SubscriptionTopic.SubscriptionTopicResourceTriggerComponent> resourceTrigger
          A definition of a resource-based event that triggers a notification based on the SubscriptionTopic. The criteria may be just a human readable description and/or a full FHIR search string or FHIRPath expression. Multiple triggers are considered OR joined (e.g., a resource update matching ANY of the definitions will trigger a notification).
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The current state of the SubscriptionTopic.
        • title
          StringType title
          A short, descriptive, user-friendly title for the subscription topic. For example, "admission".
        • url
          UriType url
          An absolute URI that is used to identify this subscription topic 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 an authoritative instance of this subscription topic is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the subscription topic 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 terms may be used to assist with indexing and searching of code system definitions.
        • version
          StringType version
          The identifier that is used to identify this version of the subscription topic when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Topic 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 are orderable.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • Class org.hl7.fhir.r5.model.SubscriptionTopic.CriteriaNotExistsBehaviorEnumFactory

      class CriteriaNotExistsBehaviorEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.SubscriptionTopic.InteractionTriggerEnumFactory

      class InteractionTriggerEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.SubscriptionTopic.SubscriptionTopicCanFilterByComponent

      class SubscriptionTopicCanFilterByComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1521606527L

      • Serialized Fields

        • comparator
          List<Enumeration<Enumerations.SearchComparator>> comparator
          Comparators allowed for the filter parameter.
        • description
          MarkdownType description
          Description of how this filtering parameter is intended to be used.
        • filterDefinition
          UriType filterDefinition
          Either the canonical URL to a search parameter (like "http://hl7.org/fhir/SearchParameter/encounter-patient") or the officially-defined URI for a shared filter concept (like "http://example.org/concepts/shared-common-event").
        • filterParameter
          StringType filterParameter
          Either the canonical URL to a search parameter (like "http://hl7.org/fhir/SearchParameter/encounter-patient") or topic-defined parameter (like "hub.event") which is a label for the filter.
        • modifier
          List<Enumeration<Enumerations.SearchModifierCode>> modifier
          Modifiers allowed for the filter parameter.
        • resource
          UriType resource
          URL of the Resource that is the type used in this filter. This is the "focus" of the topic (or one of them if there are more than one). It will be the same, a generality, or a specificity of SubscriptionTopic.resourceTrigger.resource or SubscriptionTopic.eventTrigger.resource when they are present.

    • Class org.hl7.fhir.r5.model.SubscriptionTopic.SubscriptionTopicEventTriggerComponent

      class SubscriptionTopicEventTriggerComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1818872110L

      • Serialized Fields

        • description
          MarkdownType description
          The human readable description of an event to trigger a notification for the SubscriptionTopic - for example, "Patient Admission, as defined in HL7v2 via message ADT^A01". Multiple values are considered OR joined (e.g., matching any single event listed).
        • event
          CodeableConcept event
          A well-defined event which can be used to trigger notifications from the SubscriptionTopic.
        • resource
          UriType resource
          URL of the Resource that is the focus type used in this event trigger. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, "Patient" maps to http://hl7.org/fhir/StructureDefinition/Patient. For more information, see ElementDefinition.type.code.

    • Class org.hl7.fhir.r5.model.SubscriptionTopic.SubscriptionTopicNotificationShapeComponent

      class SubscriptionTopicNotificationShapeComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1718592091L

      • Serialized Fields

        • include
          List<StringType> include
          Search-style _include directives, rooted in the resource for this shape. Servers SHOULD include resources listed here, if they exist and the user is authorized to receive them. Clients SHOULD be prepared to receive these additional resources, but SHALL function properly without them.
        • resource
          UriType resource
          URL of the Resource that is the type used in this shape. This is the 'focus' resource of the topic (or one of them if there are more than one) and the root resource for this shape definition. It will be the same, a generality, or a specificity of SubscriptionTopic.resourceTrigger.resource or SubscriptionTopic.eventTrigger.resource when they are present.
        • revInclude
          List<StringType> revInclude
          Search-style _revinclude directives, rooted in the resource for this shape. Servers SHOULD include resources listed here, if they exist and the user is authorized to receive them. Clients SHOULD be prepared to receive these additional resources, but SHALL function properly without them.

    • Class org.hl7.fhir.r5.model.SubscriptionTopic.SubscriptionTopicResourceTriggerComponent

      class SubscriptionTopicResourceTriggerComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1086940999L

      • Serialized Fields

        • description
          MarkdownType description
          The human readable description of this resource trigger for the SubscriptionTopic - for example, "An Encounter enters the 'in-progress' state".
        • fhirPathCriteria
          StringType fhirPathCriteria
          The FHIRPath based rules that the server should use to determine when to trigger a notification for this topic.
        • queryCriteria
          SubscriptionTopic.SubscriptionTopicResourceTriggerQueryCriteriaComponent queryCriteria
          The FHIR query based rules that the server should use to determine when to trigger a notification for this subscription topic.
        • resource
          UriType resource
          URL of the Resource that is the type used in this resource trigger. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, "Patient" maps to http://hl7.org/fhir/StructureDefinition/Patient. For more information, see ElementDefinition.type.code.
        • supportedInteraction
          List<Enumeration<SubscriptionTopic.InteractionTrigger>> supportedInteraction
          The FHIR RESTful interaction which can be used to trigger a notification for the SubscriptionTopic. Multiple values are considered OR joined (e.g., CREATE or UPDATE). If not present, all supported interactions are assumed.

    • Class org.hl7.fhir.r5.model.SubscriptionTopic.SubscriptionTopicResourceTriggerQueryCriteriaComponent

      class SubscriptionTopicResourceTriggerQueryCriteriaComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -291746067L

      • Serialized Fields

        • current
          StringType current
          The FHIR query based rules are applied to the current resource state (e.g., state after an update).
        • previous
          StringType previous
          The FHIR query based rules are applied to the previous resource state (e.g., state before an update).
        • requireBoth
          BooleanType requireBoth
          If set to `true`, both the `current` and `previous` query criteria must evaluate `true` to trigger a notification for this topic. If set to `false` or not present, a notification for this topic will be triggered if either the `current` or `previous` tests evaluate to `true`.
        • resultForCreate
          Enumeration<SubscriptionTopic.CriteriaNotExistsBehavior> resultForCreate
          For `create` interactions, should the `previous` criteria count as an automatic pass or an automatic fail. If not present, the testing behavior during `create` interactions is unspecified (server discretion).
        • resultForDelete
          Enumeration<SubscriptionTopic.CriteriaNotExistsBehavior> resultForDelete
          For 'delete' interactions, should the 'current' query criteria count as an automatic pass or an automatic fail. If not present, the testing behavior during `delete` interactions is unspecified (server discretion).

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

      class Substance extends DomainResource implements Serializable
      serialVersionUID:
      -3119765L

      • Serialized Fields

        • category
          List<CodeableConcept> category
          A code that classifies the general type of substance. This is used for searching, sorting and display purposes.
        • code
          CodeableReference code
          A code (or set of codes) that identify this substance.
        • description
          MarkdownType description
          A description of the substance - its appearance, handling requirements, and other usage notes.
        • expiry
          DateTimeType expiry
          When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.
        • identifier
          List<Identifier> identifier
          Unique identifier for the substance. For an instance, an identifier associated with the package/container (usually a label affixed directly).
        • ingredient
          List<Substance.SubstanceIngredientComponent> ingredient
          A substance can be composed of other substances.
        • instance
          BooleanType instance
          A boolean to indicate if this an instance of a substance or a kind of one (a definition).
        • quantity
          Quantity quantity
          The amount of the substance.
        • status
          Enumeration<Substance.FHIRSubstanceStatus> status
          A code to indicate if the substance is actively used.

    • Class org.hl7.fhir.r5.model.Substance.FHIRSubstanceStatusEnumFactory

      class FHIRSubstanceStatusEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Substance.SubstanceIngredientComponent

      class SubstanceIngredientComponent extends BackboneElement implements Serializable
      serialVersionUID:
      2068995180L

      • Serialized Fields

        • quantity
          Ratio quantity
          The amount of the ingredient in the substance - a concentration ratio.
        • substance
          DataType substance
          Another substance that is a component of this substance.

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

      class SubstanceAmount extends BackboneType implements Serializable
      serialVersionUID:
      585120586L

      • Serialized Fields

        • amount
          DataType amount
          Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.
        • amountText
          StringType amountText
          A textual comment on a numeric value.
        • amountType
          CodeableConcept amountType
          Most elements that require a quantitative value will also have a field called amount type. Amount type should always be specified because the actual value of the amount is often dependent on it. EXAMPLE: In capturing the actual relative amounts of substances or molecular fragments it is essential to indicate whether the amount refers to a mole ratio or weight ratio. For any given element an effort should be made to use same the amount type for all related definitional elements.
        • referenceRange
          SubstanceAmount.SubstanceAmountReferenceRangeComponent referenceRange
          Reference range of possible or expected values.

    • Class org.hl7.fhir.r5.model.SubstanceAmount.SubstanceAmountReferenceRangeComponent

      class SubstanceAmountReferenceRangeComponent extends Element implements Serializable
      serialVersionUID:
      -193230412L

      • Serialized Fields

        • highLimit
          Quantity highLimit
          Upper limit possible or expected.
        • lowLimit
          Quantity lowLimit
          Lower limit possible or expected.

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

      class SubstanceDefinition extends DomainResource implements Serializable
      serialVersionUID:
      -206769887L

    • Class org.hl7.fhir.r5.model.SubstanceDefinition.SubstanceDefinitionCharacterizationComponent

      class SubstanceDefinitionCharacterizationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1561571166L

      • Serialized Fields

        • description
          MarkdownType description
          The description or justification in support of the interpretation of the data file.
        • file
          List<Attachment> file
          The data produced by the analytical instrument or a pictorial representation of that data. Examples: a JCAMP, JDX, or ADX file, or a chromatogram or spectrum analysis.
        • form
          CodeableConcept form
          Describes the nature of the chemical entity and explains, for instance, whether this is a base or a salt form.
        • technique
          CodeableConcept technique
          The method used to elucidate the characterization of the drug substance. Example: HPLC.

    • Class org.hl7.fhir.r5.model.SubstanceDefinition.SubstanceDefinitionCodeComponent

      class SubstanceDefinitionCodeComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1140562105L

      • Serialized Fields

        • code
          CodeableConcept code
          The specific code.
        • note
          List<Annotation> note
          Any comment can be provided in this field, if necessary.
        • source
          List<Reference> source
          Supporting literature.
        • status
          CodeableConcept status
          Status of the code assignment, for example 'provisional', 'approved'.
        • statusDate
          DateTimeType statusDate
          The date at which the code status was changed as part of the terminology maintenance.

    • Class org.hl7.fhir.r5.model.SubstanceDefinition.SubstanceDefinitionMoietyComponent

      class SubstanceDefinitionMoietyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      271962476L

      • Serialized Fields

        • amount
          DataType amount
          Quantitative value for this moiety.
        • identifier
          Identifier identifier
          Identifier by which this moiety substance is known.
        • measurementType
          CodeableConcept measurementType
          The measurement type of the quantitative value. In capturing the actual relative amounts of substances or molecular fragments it may be necessary to indicate whether the amount refers to, for example, a mole ratio or weight ratio.
        • molecularFormula
          StringType molecularFormula
          Molecular formula for this moiety of this substance, typically using the Hill system.
        • name
          StringType name
          Textual name for this moiety substance.
        • opticalActivity
          CodeableConcept opticalActivity
          Optical activity type.
        • role
          CodeableConcept role
          Role that the moiety is playing.
        • stereochemistry
          CodeableConcept stereochemistry
          Stereochemistry type.

    • Class org.hl7.fhir.r5.model.SubstanceDefinition.SubstanceDefinitionMolecularWeightComponent

      class SubstanceDefinitionMolecularWeightComponent extends BackboneElement implements Serializable
      serialVersionUID:
      805939780L

      • Serialized Fields

        • amount
          Quantity amount
          Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.
        • method
          CodeableConcept method
          The method by which the molecular weight was determined.
        • type
          CodeableConcept type
          Type of molecular weight such as exact, average (also known as. number average), weight average.

    • Class org.hl7.fhir.r5.model.SubstanceDefinition.SubstanceDefinitionNameComponent

      class SubstanceDefinitionNameComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1184238780L

    • Class org.hl7.fhir.r5.model.SubstanceDefinition.SubstanceDefinitionNameOfficialComponent

      class SubstanceDefinitionNameOfficialComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -2040011008L

      • Serialized Fields

        • authority
          CodeableConcept authority
          Which authority uses this official name.
        • date
          DateTimeType date
          Date of the official name change.
        • status
          CodeableConcept status
          The status of the official name, for example 'draft', 'active', 'retired'.

    • Class org.hl7.fhir.r5.model.SubstanceDefinition.SubstanceDefinitionPropertyComponent

      class SubstanceDefinitionPropertyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1659186716L

      • Serialized Fields

    • Class org.hl7.fhir.r5.model.SubstanceDefinition.SubstanceDefinitionRelationshipComponent

      class SubstanceDefinitionRelationshipComponent extends BackboneElement implements Serializable
      serialVersionUID:
      192222632L

      • Serialized Fields

        • amount
          DataType amount
          A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.
        • comparator
          CodeableConcept comparator
          An operator for the amount, for example "average", "approximately", "less than".
        • isDefining
          BooleanType isDefining
          For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships.
        • ratioHighLimitAmount
          Ratio ratioHighLimitAmount
          For use when the numeric has an uncertain range.
        • source
          List<Reference> source
          Supporting literature.
        • substanceDefinition
          DataType substanceDefinition
          A pointer to another substance, as a resource or just a representational code.
        • type
          CodeableConcept type
          For example "salt to parent", "active moiety", "starting material", "polymorph", "impurity of".

    • Class org.hl7.fhir.r5.model.SubstanceDefinition.SubstanceDefinitionSourceMaterialComponent

      class SubstanceDefinitionSourceMaterialComponent extends BackboneElement implements Serializable
      serialVersionUID:
      569352795L

      • Serialized Fields

        • countryOfOrigin
          List<CodeableConcept> countryOfOrigin
          The country or countries where the material is harvested.
        • genus
          CodeableConcept genus
          The genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name.
        • part
          CodeableConcept part
          An anatomical origin of the source material within an organism.
        • species
          CodeableConcept species
          The species of an organism, typically referring to the Latin epithet of the species of the plant/animal.
        • type
          CodeableConcept type
          A classification that provides the origin of the raw material. Example: cat hair would be an Animal source type.

    • Class org.hl7.fhir.r5.model.SubstanceDefinition.SubstanceDefinitionStructureComponent

      class SubstanceDefinitionStructureComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -2137814144L

    • Class org.hl7.fhir.r5.model.SubstanceDefinition.SubstanceDefinitionStructureRepresentationComponent

      class SubstanceDefinitionStructureRepresentationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      138704347L

      • Serialized Fields

        • document
          Reference document
          An attached file with the structural representation e.g. a molecular structure graphic of the substance, a JCAMP or AnIML file.
        • format
          CodeableConcept format
          The format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF. The logical content type rather than the physical file format of a document.
        • representation
          StringType representation
          The structural representation as a text string in a standard format.
        • type
          CodeableConcept type
          The kind of structural representation (e.g. full, partial).

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

      class SubstanceNucleicAcid extends DomainResource implements Serializable
      serialVersionUID:
      -1906822433L

      • Serialized Fields

        • areaOfHybridisation
          StringType areaOfHybridisation
          The area of hybridisation shall be described if applicable for double stranded RNA or DNA. The number associated with the subunit followed by the number associated to the residue shall be specified in increasing order. The underscore ?? shall be used as separator as follows: ?Subunitnumber Residue?.
        • numberOfSubunits
          IntegerType numberOfSubunits
          The number of linear sequences of nucleotides linked through phosphodiester bonds shall be described. Subunits would be strands of nucleic acids that are tightly associated typically through Watson-Crick base pairing. NOTE: If not specified in the reference source, the assumption is that there is 1 subunit.
        • oligoNucleotideType
          CodeableConcept oligoNucleotideType
          (TBC).
        • sequenceType
          CodeableConcept sequenceType
          The type of the sequence shall be specified based on a controlled vocabulary.
        • subunit
          List<SubstanceNucleicAcid.SubstanceNucleicAcidSubunitComponent> subunit
          Subunits are listed in order of decreasing length; sequences of the same length will be ordered by molecular weight; subunits that have identical sequences will be repeated multiple times.

    • Class org.hl7.fhir.r5.model.SubstanceNucleicAcid.SubstanceNucleicAcidSubunitComponent

      class SubstanceNucleicAcidSubunitComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1835593659L

      • Serialized Fields

        • fivePrime
          CodeableConcept fivePrime
          The nucleotide present at the 5? terminal shall be specified based on a controlled vocabulary. Since the sequence is represented from the 5' to the 3' end, the 5? prime nucleotide is the letter at the first position in the sequence. A separate representation would be redundant.
        • length
          IntegerType length
          The length of the sequence shall be captured.
        • linkage
          List<SubstanceNucleicAcid.SubstanceNucleicAcidSubunitLinkageComponent> linkage
          The linkages between sugar residues will also be captured.
        • sequence
          StringType sequence
          Actual nucleotide sequence notation from 5' to 3' end using standard single letter codes. In addition to the base sequence, sugar and type of phosphate or non-phosphate linkage should also be captured.
        • sequenceAttachment
          Attachment sequenceAttachment
          (TBC).
        • subunit
          IntegerType subunit
          Index of linear sequences of nucleic acids in order of decreasing length. Sequences of the same length will be ordered by molecular weight. Subunits that have identical sequences will be repeated and have sequential subscripts.
        • sugar
          List<SubstanceNucleicAcid.SubstanceNucleicAcidSubunitSugarComponent> sugar
          5.3.6.8.1 Sugar ID (Mandatory).
        • threePrime
          CodeableConcept threePrime
          The nucleotide present at the 3? terminal shall be specified based on a controlled vocabulary. Since the sequence is represented from the 5' to the 3' end, the 5? prime nucleotide is the letter at the last position in the sequence. A separate representation would be redundant.

    • Class org.hl7.fhir.r5.model.SubstanceNucleicAcid.SubstanceNucleicAcidSubunitLinkageComponent

      class SubstanceNucleicAcidSubunitLinkageComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1392155799L

      • Serialized Fields

        • connectivity
          StringType connectivity
          The entity that links the sugar residues together should also be captured for nearly all naturally occurring nucleic acid the linkage is a phosphate group. For many synthetic oligonucleotides phosphorothioate linkages are often seen. Linkage connectivity is assumed to be 3?-5?. If the linkage is either 3?-3? or 5?-5? this should be specified.
        • identifier
          Identifier identifier
          Each linkage will be registered as a fragment and have an ID.
        • name
          StringType name
          Each linkage will be registered as a fragment and have at least one name. A single name shall be assigned to each linkage.
        • residueSite
          StringType residueSite
          Residues shall be captured as described in 5.3.6.8.3.

    • Class org.hl7.fhir.r5.model.SubstanceNucleicAcid.SubstanceNucleicAcidSubunitSugarComponent

      class SubstanceNucleicAcidSubunitSugarComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1933713781L

      • Serialized Fields

        • identifier
          Identifier identifier
          The Substance ID of the sugar or sugar-like component that make up the nucleotide.
        • name
          StringType name
          The name of the sugar or sugar-like component that make up the nucleotide.
        • residueSite
          StringType residueSite
          The residues that contain a given sugar will be captured. The order of given residues will be captured in the 5?-3?direction consistent with the base sequences listed above.

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

      class SubstancePolymer extends DomainResource implements Serializable
      serialVersionUID:
      11937102L

    • Class org.hl7.fhir.r5.model.SubstancePolymer.SubstancePolymerMonomerSetComponent

      class SubstancePolymerMonomerSetComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -933825014L

    • Class org.hl7.fhir.r5.model.SubstancePolymer.SubstancePolymerMonomerSetStartingMaterialComponent

      class SubstancePolymerMonomerSetStartingMaterialComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1199515148L

      • Serialized Fields

        • amount
          Quantity amount
          A percentage.
        • category
          CodeableConcept category
          Substance high level category, e.g. chemical substance.
        • code
          CodeableConcept code
          The type of substance for this starting material.
        • isDefining
          BooleanType isDefining
          Used to specify whether the attribute described is a defining element for the unique identification of the polymer.

    • Class org.hl7.fhir.r5.model.SubstancePolymer.SubstancePolymerRepeatComponent

      class SubstancePolymerRepeatComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -366644176L

    • Class org.hl7.fhir.r5.model.SubstancePolymer.SubstancePolymerRepeatRepeatUnitComponent

      class SubstancePolymerRepeatRepeatUnitComponent extends BackboneElement implements Serializable
      serialVersionUID:
      727054044L

    • Class org.hl7.fhir.r5.model.SubstancePolymer.SubstancePolymerRepeatRepeatUnitDegreeOfPolymerisationComponent

      class SubstancePolymerRepeatRepeatUnitDegreeOfPolymerisationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1950663748L

      • Serialized Fields

        • average
          IntegerType average
          An average amount of polymerisation.
        • high
          IntegerType high
          A high expected limit of the amount.
        • low
          IntegerType low
          A low expected limit of the amount.
        • type
          CodeableConcept type
          The type of the degree of polymerisation shall be described, e.g. SRU/Polymer Ratio.

    • Class org.hl7.fhir.r5.model.SubstancePolymer.SubstancePolymerRepeatRepeatUnitStructuralRepresentationComponent

      class SubstancePolymerRepeatRepeatUnitStructuralRepresentationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1385695515L

      • Serialized Fields

        • attachment
          Attachment attachment
          An attached file with the structural representation.
        • format
          CodeableConcept format
          The format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF.
        • representation
          StringType representation
          The structural representation as text string in a standard format e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF.
        • type
          CodeableConcept type
          The type of structure (e.g. Full, Partial, Representative).

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

      class SubstanceProtein extends DomainResource implements Serializable
      serialVersionUID:
      469786856L

      • Serialized Fields

        • disulfideLinkage
          List<StringType> disulfideLinkage
          The disulphide bond between two cysteine residues either on the same subunit or on two different subunits shall be described. The position of the disulfide bonds in the SubstanceProtein shall be listed in increasing order of subunit number and position within subunit followed by the abbreviation of the amino acids involved. The disulfide linkage positions shall actually contain the amino acid Cysteine at the respective positions.
        • numberOfSubunits
          IntegerType numberOfSubunits
          Number of linear sequences of amino acids linked through peptide bonds. The number of subunits constituting the SubstanceProtein shall be described. It is possible that the number of subunits can be variable.
        • sequenceType
          CodeableConcept sequenceType
          The SubstanceProtein descriptive elements will only be used when a complete or partial amino acid sequence is available or derivable from a nucleic acid sequence.
        • subunit
          List<SubstanceProtein.SubstanceProteinSubunitComponent> subunit
          This subclause refers to the description of each subunit constituting the SubstanceProtein. A subunit is a linear sequence of amino acids linked through peptide bonds. The Subunit information shall be provided when the finished SubstanceProtein is a complex of multiple sequences; subunits are not used to delineate domains within a single sequence. Subunits are listed in order of decreasing length; sequences of the same length will be ordered by decreasing molecular weight; subunits that have identical sequences will be repeated multiple times.

    • Class org.hl7.fhir.r5.model.SubstanceProtein.SubstanceProteinSubunitComponent

      class SubstanceProteinSubunitComponent extends BackboneElement implements Serializable
      serialVersionUID:
      99973841L

      • Serialized Fields

        • cTerminalModification
          StringType cTerminalModification
          The modification at the C-terminal shall be specified.
        • cTerminalModificationId
          Identifier cTerminalModificationId
          Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID.
        • length
          IntegerType length
          Length of linear sequences of amino acids contained in the subunit.
        • nTerminalModification
          StringType nTerminalModification
          The name of the fragment modified at the N-terminal of the SubstanceProtein shall be specified.
        • nTerminalModificationId
          Identifier nTerminalModificationId
          Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID.
        • sequence
          StringType sequence
          The sequence information shall be provided enumerating the amino acids from N- to C-terminal end using standard single-letter amino acid codes. Uppercase shall be used for L-amino acids and lowercase for D-amino acids. Transcribed SubstanceProteins will always be described using the translated sequence; for synthetic peptide containing amino acids that are not represented with a single letter code an X should be used within the sequence. The modified amino acids will be distinguished by their position in the sequence.
        • sequenceAttachment
          Attachment sequenceAttachment
          The sequence information shall be provided enumerating the amino acids from N- to C-terminal end using standard single-letter amino acid codes. Uppercase shall be used for L-amino acids and lowercase for D-amino acids. Transcribed SubstanceProteins will always be described using the translated sequence; for synthetic peptide containing amino acids that are not represented with a single letter code an X should be used within the sequence. The modified amino acids will be distinguished by their position in the sequence.
        • subunit
          IntegerType subunit
          Index of primary sequences of amino acids linked through peptide bonds in order of decreasing length. Sequences of the same length will be ordered by molecular weight. Subunits that have identical sequences will be repeated and have sequential subscripts.

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

      class SubstanceReferenceInformation extends DomainResource implements Serializable
      serialVersionUID:
      -496299386L

    • Class org.hl7.fhir.r5.model.SubstanceReferenceInformation.SubstanceReferenceInformationGeneComponent

      class SubstanceReferenceInformationGeneComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1733820939L

    • Class org.hl7.fhir.r5.model.SubstanceReferenceInformation.SubstanceReferenceInformationGeneElementComponent

      class SubstanceReferenceInformationGeneElementComponent extends BackboneElement implements Serializable
      serialVersionUID:
      261257288L

    • Class org.hl7.fhir.r5.model.SubstanceReferenceInformation.SubstanceReferenceInformationTargetComponent

      class SubstanceReferenceInformationTargetComponent extends BackboneElement implements Serializable
      serialVersionUID:
      819518021L

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

      class SubstanceSourceMaterial extends DomainResource implements Serializable
      serialVersionUID:
      442657667L

      • Serialized Fields

        • countryOfOrigin
          List<CodeableConcept> countryOfOrigin
          The country where the plant material is harvested or the countries where the plasma is sourced from as laid down in accordance with the Plasma Master File. For ?Plasma-derived substances? the attribute country of origin provides information about the countries used for the manufacturing of the Cryopoor plama or Crioprecipitate.
        • developmentStage
          CodeableConcept developmentStage
          Stage of life for animals, plants, insects and microorganisms. This information shall be provided only when the substance is significantly different in these stages (e.g. foetal bovine serum).
        • fractionDescription
          List<SubstanceSourceMaterial.SubstanceSourceMaterialFractionDescriptionComponent> fractionDescription
          Many complex materials are fractions of parts of plants, animals, or minerals. Fraction elements are often necessary to define both Substances and Specified Group 1 Substances. For substances derived from Plants, fraction information will be captured at the Substance information level ( . Oils, Juices and Exudates). Additional information for Extracts, such as extraction solvent composition, will be captured at the Specified Substance Group 1 information level. For plasma-derived products fraction information will be captured at the Substance and the Specified Substance Group 1 levels.
        • geographicalLocation
          List<StringType> geographicalLocation
          The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.
        • organism
          SubstanceSourceMaterial.SubstanceSourceMaterialOrganismComponent organism
          This subclause describes the organism which the substance is derived from. For vaccines, the parent organism shall be specified based on these subclause elements. As an example, full taxonomy will be described for the Substance Name: ., Leaf.
        • organismId
          Identifier organismId
          The unique identifier associated with the source material parent organism shall be specified.
        • organismName
          StringType organismName
          The organism accepted Scientific name shall be provided based on the organism taxonomy.
        • parentSubstanceId
          List<Identifier> parentSubstanceId
          The parent of the herbal drug Ginkgo biloba, Leaf is the substance ID of the substance (fresh) of Ginkgo biloba L. or Ginkgo biloba L. (Whole plant).
        • parentSubstanceName
          List<StringType> parentSubstanceName
          The parent substance of the Herbal Drug, or Herbal preparation.
        • partDescription
          List<SubstanceSourceMaterial.SubstanceSourceMaterialPartDescriptionComponent> partDescription
          To do.
        • sourceMaterialClass
          CodeableConcept sourceMaterialClass
          General high level classification of the source material specific to the origin of the material.
        • sourceMaterialState
          CodeableConcept sourceMaterialState
          The state of the source material when extracted.
        • sourceMaterialType
          CodeableConcept sourceMaterialType
          The type of the source material shall be specified based on a controlled vocabulary. For vaccines, this subclause refers to the class of infectious agent.

    • Class org.hl7.fhir.r5.model.SubstanceSourceMaterial.SubstanceSourceMaterialFractionDescriptionComponent

      class SubstanceSourceMaterialFractionDescriptionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1118226733L

      • Serialized Fields

        • fraction
          StringType fraction
          This element is capturing information about the fraction of a plant part, or human plasma for fractionation.
        • materialType
          CodeableConcept materialType
          The specific type of the material constituting the component. For Herbal preparations the particulars of the extracts (liquid/dry) is described in Specified Substance Group 1.

    • Class org.hl7.fhir.r5.model.SubstanceSourceMaterial.SubstanceSourceMaterialOrganismAuthorComponent

      class SubstanceSourceMaterialOrganismAuthorComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1429770120L

      • Serialized Fields

        • authorDescription
          StringType authorDescription
          The author of an organism species shall be specified. The author year of an organism shall also be specified when applicable; refers to the year in which the first author(s) published the infraspecific plant/animal name (of any rank).
        • authorType
          CodeableConcept authorType
          The type of author of an organism species shall be specified. The parenthetical author of an organism species refers to the first author who published the plant/animal name (of any rank). The primary author of an organism species refers to the first author(s), who validly published the plant/animal name.

    • Class org.hl7.fhir.r5.model.SubstanceSourceMaterial.SubstanceSourceMaterialOrganismComponent

      class SubstanceSourceMaterialOrganismComponent extends BackboneElement implements Serializable
      serialVersionUID:
      941648312L

    • Class org.hl7.fhir.r5.model.SubstanceSourceMaterial.SubstanceSourceMaterialOrganismHybridComponent

      class SubstanceSourceMaterialOrganismHybridComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1981189787L

      • Serialized Fields

        • hybridType
          CodeableConcept hybridType
          The hybrid type of an organism shall be specified.
        • maternalOrganismId
          StringType maternalOrganismId
          The identifier of the maternal species constituting the hybrid organism shall be specified based on a controlled vocabulary. For plants, the parents aren?t always known, and it is unlikely that it will be known which is maternal and which is paternal.
        • maternalOrganismName
          StringType maternalOrganismName
          The name of the maternal species constituting the hybrid organism shall be specified. For plants, the parents aren?t always known, and it is unlikely that it will be known which is maternal and which is paternal.
        • paternalOrganismId
          StringType paternalOrganismId
          The identifier of the paternal species constituting the hybrid organism shall be specified based on a controlled vocabulary.
        • paternalOrganismName
          StringType paternalOrganismName
          The name of the paternal species constituting the hybrid organism shall be specified.

    • Class org.hl7.fhir.r5.model.SubstanceSourceMaterial.SubstanceSourceMaterialOrganismOrganismGeneralComponent

      class SubstanceSourceMaterialOrganismOrganismGeneralComponent extends BackboneElement implements Serializable
      serialVersionUID:
      659838613L

      • Serialized Fields

        • class_
          CodeableConcept class_
          The class of an organism shall be specified.
        • kingdom
          CodeableConcept kingdom
          The kingdom of an organism shall be specified.
        • order
          CodeableConcept order
          The order of an organism shall be specified,.
        • phylum
          CodeableConcept phylum
          The phylum of an organism shall be specified.

    • Class org.hl7.fhir.r5.model.SubstanceSourceMaterial.SubstanceSourceMaterialPartDescriptionComponent

      class SubstanceSourceMaterialPartDescriptionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      308875915L

      • Serialized Fields

        • part
          CodeableConcept part
          Entity of anatomical origin of source material within an organism.
        • partLocation
          CodeableConcept partLocation
          The detailed anatomic location when the part can be extracted from different anatomical locations of the organism. Multiple alternative locations may apply.

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

      class SupplyDelivery extends DomainResource implements Serializable
      serialVersionUID:
      -734856482L

      • Serialized Fields

        • basedOn
          List<Reference> basedOn
          A plan, proposal or order that is fulfilled in whole or in part by this event.
        • destination
          Reference destination
          Identification of the facility/location where the delivery was shipped to.
        • identifier
          List<Identifier> identifier
          Identifier for the supply delivery event that is used to identify it across multiple disparate systems.
        • occurrence
          DataType occurrence
          The date or time(s) the activity occurred.
        • partOf
          List<Reference> partOf
          A larger event of which this particular event is a component or step.
        • patient
          Reference patient
          A link to a resource representing the person whom the delivered item is for.
        • receiver
          List<Reference> receiver
          Identifies the individual or organization that received the delivery.
        • status
          Enumeration<SupplyDelivery.SupplyDeliveryStatus> status
          A code specifying the state of the dispense event.
        • suppliedItem
          List<SupplyDelivery.SupplyDeliverySuppliedItemComponent> suppliedItem
          The item that is being delivered or has been supplied.
        • supplier
          Reference supplier
          The individual or organization responsible for supplying the delivery.
        • type
          CodeableConcept type
          Indicates the type of supply being provided. Examples include: Medication, Device, Biologically Derived Product.

    • Class org.hl7.fhir.r5.model.SupplyDelivery.SupplyDeliveryStatusEnumFactory

      class SupplyDeliveryStatusEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.SupplyDelivery.SupplyDeliverySuppliedItemComponent

      class SupplyDeliverySuppliedItemComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -615919419L

      • Serialized Fields

        • item
          DataType item
          Identifies the medication, substance, device or biologically derived product being supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.
        • quantity
          Quantity quantity
          The amount of the item that has been supplied. Unit of measure may be included.

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

      class SupplyRequest extends DomainResource implements Serializable
      serialVersionUID:
      -1701051976L

      • Serialized Fields

        • authoredOn
          DateTimeType authoredOn
          When the request was made.
        • basedOn
          List<Reference> basedOn
          Plan/proposal/order fulfilled by this request.
        • category
          CodeableConcept category
          Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.
        • deliverFor
          Reference deliverFor
          The patient to whom the supply will be given or for whom they will be used.
        • deliverFrom
          Reference deliverFrom
          Where the supply is expected to come from.
        • deliverTo
          Reference deliverTo
          Where the supply is destined to go.
        • identifier
          List<Identifier> identifier
          Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.
        • item
          CodeableReference item
          The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.
        • occurrence
          DataType occurrence
          When the request should be fulfilled.
        • parameter
          List<SupplyRequest.SupplyRequestParameterComponent> parameter
          Specific parameters for the ordered item. For example, the size of the indicated item.
        • priority
          Enumeration<Enumerations.RequestPriority> priority
          Indicates how quickly this SupplyRequest should be addressed with respect to other requests.
        • quantity
          Quantity quantity
          The amount that is being ordered of the indicated item.
        • reason
          List<CodeableReference> reason
          The reason why the supply item was requested.
        • requester
          Reference requester
          The device, practitioner, etc. who initiated the request.
        • status
          Enumeration<SupplyRequest.SupplyRequestStatus> status
          Status of the supply request.
        • supplier
          List<Reference> supplier
          Who is intended to fulfill the request.

    • Class org.hl7.fhir.r5.model.SupplyRequest.SupplyRequestParameterComponent

      class SupplyRequestParameterComponent 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.SupplyRequest.SupplyRequestStatusEnumFactory

      class SupplyRequestStatusEnumFactory extends Object implements Serializable

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

      class Task extends DomainResource implements Serializable
      serialVersionUID:
      1363715195L

      • Serialized Fields

        • authoredOn
          DateTimeType authoredOn
          The date and time this task was created.
        • basedOn
          List<Reference> basedOn
          BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by focus. For example, based on a CarePlan (= basedOn), a task is created to fulfill a ServiceRequest ( = focus ) to collect a specimen from a patient.
        • businessStatus
          CodeableConcept businessStatus
          Contains business-specific nuances of the business state.
        • code
          CodeableConcept code
          A name or code (or both) briefly describing what the task involves.
        • description
          StringType description
          A free-text description of what is to be performed.
        • doNotPerform
          BooleanType doNotPerform
          If true indicates that the Task is asking for the specified action to *not* occur.
        • encounter
          Reference encounter
          The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.
        • executionPeriod
          Period executionPeriod
          Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).
        • focus
          Reference focus
          The request being fulfilled or the resource being manipulated (changed, suspended, etc.) by this task.
        • for_
          Reference for_
          The entity who benefits from the performance of the service specified in the task (e.g., the patient).
        • groupIdentifier
          Identifier groupIdentifier
          A shared identifier common to multiple independent Task and Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.
        • identifier
          List<Identifier> identifier
          The business identifier for this task.
        • input
          List<Task.TaskInputComponent> input
          Additional information that may be needed in the execution of the task.
        • instantiatesCanonical
          CanonicalType instantiatesCanonical
          The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
        • instantiatesUri
          UriType instantiatesUri
          The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
        • insurance
          List<Reference> insurance
          Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.
        • intent
          Enumeration<Task.TaskIntent> intent
          Indicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.
        • lastModified
          DateTimeType lastModified
          The date and time of last modification to this task.
        • location
          Reference location
          Principal physical location where this task is performed.
        • note
          List<Annotation> note
          Free-text information captured about the task as it progresses.
        • output
          List<Task.TaskOutputComponent> output
          Outputs produced by the Task.
        • owner
          Reference owner
          Party responsible for managing task execution.
        • partOf
          List<Reference> partOf
          Task that this particular task is part of.
        • performer
          List<Task.TaskPerformerComponent> performer
          The entity who performed the requested task.
        • priority
          Enumeration<Enumerations.RequestPriority> priority
          Indicates how quickly the Task should be addressed with respect to other requests.
        • reason
          List<CodeableReference> reason
          A description, code, or reference indicating why this task needs to be performed.
        • relevantHistory
          List<Reference> relevantHistory
          Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.
        • requestedPerformer
          List<CodeableReference> requestedPerformer
          The kind of participant or specific participant that should perform the task.
        • requestedPeriod
          Period requestedPeriod
          Indicates the start and/or end of the period of time when completion of the task is desired to take place.
        • requester
          Reference requester
          The creator of the task.
        • restriction
          Task.TaskRestrictionComponent restriction
          If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.
        • status
          Enumeration<Task.TaskStatus> status
          The current status of the task.
        • statusReason
          CodeableReference statusReason
          An explanation as to why this task is held, failed, was refused, etc.

    • Class org.hl7.fhir.r5.model.Task.TaskInputComponent

      class TaskInputComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1659186716L

      • Serialized Fields

        • type
          CodeableConcept type
          A code or description indicating how the input is intended to be used as part of the task execution.
        • value
          DataType value
          The value of the input parameter as a basic type.

    • Class org.hl7.fhir.r5.model.Task.TaskIntentEnumFactory

      class TaskIntentEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Task.TaskOutputComponent

      class TaskOutputComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1659186716L

      • Serialized Fields

        • type
          CodeableConcept type
          The name of the Output parameter.
        • value
          DataType value
          The value of the Output parameter as a basic type.

    • Class org.hl7.fhir.r5.model.Task.TaskPerformerComponent

      class TaskPerformerComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -576943815L

      • Serialized Fields

        • actor
          Reference actor
          The actor or entity who performed the task.
        • function
          CodeableConcept function
          A code or description of the performer of the task.

    • Class org.hl7.fhir.r5.model.Task.TaskRestrictionComponent

      class TaskRestrictionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1673996066L

      • Serialized Fields

        • period
          Period period
          The time-period for which fulfillment is sought. This must fall within the overall time period authorized in the referenced request. E.g. ServiceRequest.occurance[x].
        • recipient
          List<Reference> recipient
          For requests that are targeted to more than one potential recipient/target, to identify who is fulfillment is sought for.
        • repetitions
          PositiveIntType repetitions
          Indicates the number of times the requested action should occur.

    • Class org.hl7.fhir.r5.model.Task.TaskStatusEnumFactory

      class TaskStatusEnumFactory extends Object implements Serializable

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

      class TerminologyCapabilities extends CanonicalResource implements Serializable
      serialVersionUID:
      179684544L

      • Serialized Fields

        • closure
          TerminologyCapabilities.TerminologyCapabilitiesClosureComponent closure
          Whether the $closure operation is supported.
        • codeSearch
          Enumeration<TerminologyCapabilities.CodeSearchSupport> codeSearch
          The degree to which the server supports the code search parameter on ValueSet, if it is supported.
        • codeSystem
          List<TerminologyCapabilities.TerminologyCapabilitiesCodeSystemComponent> codeSystem
          Identifies a code system that is supported by the server. If there is a no code system URL, then this declares the general assumptions a client can make about support for any CodeSystem resource.
        • 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 terminology capabilities and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the terminology capabilities.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the terminology capabilities was last significantly changed. 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 terminology capabilities changes.
        • description
          MarkdownType description
          A free text natural language description of the terminology capabilities 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.
        • expansion
          TerminologyCapabilities.TerminologyCapabilitiesExpansionComponent expansion
          Information about the [ValueSet/$expand](valueset-operation-expand.html) operation.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this terminology capabilities 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 terminology capabilities when it is represented in other formats, or referenced in a specification, model, design or an instance.
        • implementation
          TerminologyCapabilities.TerminologyCapabilitiesImplementationComponent implementation
          Identifies a specific implementation instance that is described by the terminology capability statement - i.e. a particular installation, rather than the capabilities of a software program.
        • jurisdiction
          List<CodeableConcept> jurisdiction
          A legal or geographic region in which the terminology capabilities 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).
        • lockedDate
          BooleanType lockedDate
          Whether the server supports lockedDate.
        • name
          StringType name
          A natural language name identifying the terminology capabilities. 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 responsible for the release and ongoing maintenance of the terminology capabilities.
        • purpose
          MarkdownType purpose
          Explanation of why this terminology capabilities is needed and why it has been designed as it has.
        • software
          TerminologyCapabilities.TerminologyCapabilitiesSoftwareComponent software
          Software that is covered by this terminology capability statement. It is used when the statement describes the capabilities of a particular software version, independent of an installation.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this terminology capabilities. Enables tracking the life-cycle of the content.
        • title
          StringType title
          A short, descriptive, user-friendly title for the terminology capabilities.
        • translation
          TerminologyCapabilities.TerminologyCapabilitiesTranslationComponent translation
          Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation.
        • url
          UriType url
          An absolute URI that is used to identify this terminology capabilities 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 an authoritative instance of this terminology capabilities is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the terminology capabilities 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 terminology capabilities instances.
        • validateCode
          TerminologyCapabilities.TerminologyCapabilitiesValidateCodeComponent validateCode
          Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation.
        • version
          StringType version
          The identifier that is used to identify this version of the terminology capabilities when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the terminology capabilities 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • Class org.hl7.fhir.r5.model.TerminologyCapabilities.CodeSearchSupportEnumFactory

      class CodeSearchSupportEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.TerminologyCapabilities.TerminologyCapabilitiesClosureComponent

      class TerminologyCapabilitiesClosureComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1900484343L

      • Serialized Fields

        • translation
          BooleanType translation
          If cross-system closure is supported.

    • Class org.hl7.fhir.r5.model.TerminologyCapabilities.TerminologyCapabilitiesCodeSystemComponent

      class TerminologyCapabilitiesCodeSystemComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1589208601L

    • Class org.hl7.fhir.r5.model.TerminologyCapabilities.TerminologyCapabilitiesCodeSystemVersionComponent

      class TerminologyCapabilitiesCodeSystemVersionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      658198795L

    • Class org.hl7.fhir.r5.model.TerminologyCapabilities.TerminologyCapabilitiesCodeSystemVersionFilterComponent

      class TerminologyCapabilitiesCodeSystemVersionFilterComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -489160282L

      • Serialized Fields

        • code
          CodeType code
          Code of the property supported.
        • op
          List<CodeType> op
          Operations supported for the property.

    • Class org.hl7.fhir.r5.model.TerminologyCapabilities.TerminologyCapabilitiesExpansionComponent

      class TerminologyCapabilitiesExpansionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1011350616L

    • Class org.hl7.fhir.r5.model.TerminologyCapabilities.TerminologyCapabilitiesExpansionParameterComponent

      class TerminologyCapabilitiesExpansionParameterComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1703372741L

      • Serialized Fields

        • documentation
          StringType documentation
          Description of support for parameter.
        • name
          CodeType name
          Name of the supported expansion parameter.

    • Class org.hl7.fhir.r5.model.TerminologyCapabilities.TerminologyCapabilitiesImplementationComponent

      class TerminologyCapabilitiesImplementationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      98009649L

      • Serialized Fields

        • description
          StringType description
          Information about the specific installation that this terminology capability statement relates to.
        • url
          UrlType url
          An absolute base URL for the implementation.

    • Class org.hl7.fhir.r5.model.TerminologyCapabilities.TerminologyCapabilitiesSoftwareComponent

      class TerminologyCapabilitiesSoftwareComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -790299911L

      • Serialized Fields

        • name
          StringType name
          Name the software is known by.
        • version
          StringType version
          The version identifier for the software covered by this statement.

    • Class org.hl7.fhir.r5.model.TerminologyCapabilities.TerminologyCapabilitiesTranslationComponent

      class TerminologyCapabilitiesTranslationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1727843575L

      • Serialized Fields

        • needsMap
          BooleanType needsMap
          Whether the client must identify the map.

    • Class org.hl7.fhir.r5.model.TerminologyCapabilities.TerminologyCapabilitiesValidateCodeComponent

      class TerminologyCapabilitiesValidateCodeComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1212814906L

      • Serialized Fields

        • translations
          BooleanType translations
          Whether translations are validated.

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

      class TestPlan extends CanonicalResource implements Serializable
      serialVersionUID:
      235546950L

      • Serialized Fields

        • category
          List<CodeableConcept> category
          The category of the Test Plan - can be acceptance, unit, performance, etc.
        • 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 test plan and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the test plan. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the test plan was last significantly changed. 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 test plan changes.
        • dependency
          List<TestPlan.TestPlanDependencyComponent> dependency
          The required criteria to execute the test plan - e.g. preconditions, previous tests...
        • description
          MarkdownType description
          A free text natural language description of the test plan from a consumer's perspective.
        • exitCriteria
          MarkdownType exitCriteria
          The threshold or criteria for the test plan to be considered successfully executed - narrative.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this test plan 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 test plan 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 test plan is intended to be used.
        • name
          StringType name
          A natural language name identifying the test plan. 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 responsible for the release and ongoing maintenance of the test plan.
        • purpose
          MarkdownType purpose
          Explanation of why this test plan is needed and why it has been designed as it has.
        • scope
          List<Reference> scope
          What is being tested with this Test Plan - a conformance resource, or narrative criteria, or an external reference...
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this test plan. Enables tracking the life-cycle of the content.
        • testCase
          List<TestPlan.TestPlanTestCaseComponent> testCase
          The individual test cases that are part of this plan, when they they are made explicit.
        • testTools
          MarkdownType testTools
          A description of test tools to be used in the test plan.
        • title
          StringType title
          A short, descriptive, user-friendly title for the test plan.
        • url
          UriType url
          An absolute URI that is used to identify this test plan 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 an authoritative instance of this test plan is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the test plan 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 test plan instances.
        • version
          StringType version
          The identifier that is used to identify this version of the test plan when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the test plan 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • Class org.hl7.fhir.r5.model.TestPlan.TestCaseDependencyComponent

      class TestCaseDependencyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1630757943L

      • Serialized Fields

        • description
          MarkdownType description
          Description of the criteria.
        • predecessor
          Reference predecessor
          Link to predecessor test plans.

    • Class org.hl7.fhir.r5.model.TestPlan.TestPlanDependencyComponent

      class TestPlanDependencyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1630757943L

      • Serialized Fields

        • description
          MarkdownType description
          A textual description of the criterium - what is needed for the dependency to be considered met.
        • predecessor
          Reference predecessor
          Predecessor test plans - those that are expected to be successfully performed as a dependency for the execution of this test plan.

    • Class org.hl7.fhir.r5.model.TestPlan.TestPlanTestCaseAssertionComponent

      class TestPlanTestCaseAssertionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      481177705L

      • Serialized Fields

        • object
          List<CodeableReference> object
          The focus or object of the assertion i.e. a resource.
        • result
          List<CodeableReference> result
          The test assertion - the expected outcome from the test case execution.
        • type
          List<CodeableConcept> type
          The test assertion type - this can be used to group assertions as 'required' or 'optional', or can be used for other classification of the assertion.

    • Class org.hl7.fhir.r5.model.TestPlan.TestPlanTestCaseComponent

      class TestPlanTestCaseComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1605296611L

    • Class org.hl7.fhir.r5.model.TestPlan.TestPlanTestCaseTestDataComponent

      class TestPlanTestCaseTestDataComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -300912813L

      • Serialized Fields

        • content
          Reference content
          The actual test resources when they exist.
        • source
          DataType source
          Pointer to a definition of test resources - narrative or structured e.g. synthetic data generation, etc.
        • type
          Coding type
          The type of test data description, e.g. 'synthea'.

    • Class org.hl7.fhir.r5.model.TestPlan.TestPlanTestCaseTestRunComponent

      class TestPlanTestCaseTestRunComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -763780736L

    • Class org.hl7.fhir.r5.model.TestPlan.TestPlanTestCaseTestRunScriptComponent

      class TestPlanTestCaseTestRunScriptComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1308596610L

      • Serialized Fields

        • language
          CodeableConcept language
          The language for the test cases e.g. 'gherkin', 'testscript'.
        • source
          DataType source
          The actual content of the cases - references to TestScripts or externally defined content.

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

      class TestReport extends DomainResource implements Serializable
      serialVersionUID:
      -1863229334L

    • Class org.hl7.fhir.r5.model.TestReport.SetupActionAssertComponent

      class SetupActionAssertComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -132618689L

    • Class org.hl7.fhir.r5.model.TestReport.SetupActionAssertRequirementComponent

      class SetupActionAssertRequirementComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -91187948L

      • Serialized Fields

        • link
          DataType link
          Link or reference providing traceability to the testing requirement for this test.

    • Class org.hl7.fhir.r5.model.TestReport.SetupActionComponent

      class SetupActionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -252088305L

    • Class org.hl7.fhir.r5.model.TestReport.SetupActionOperationComponent

      class SetupActionOperationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      269088798L

    • Class org.hl7.fhir.r5.model.TestReport.TeardownActionComponent

      class TeardownActionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1099598054L

    • Class org.hl7.fhir.r5.model.TestReport.TestActionComponent

      class TestActionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -252088305L

    • Class org.hl7.fhir.r5.model.TestReport.TestReportActionResultEnumFactory

      class TestReportActionResultEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.TestReport.TestReportParticipantComponent

      class TestReportParticipantComponent extends BackboneElement implements Serializable
      serialVersionUID:
      577488357L

    • Class org.hl7.fhir.r5.model.TestReport.TestReportParticipantTypeEnumFactory

      class TestReportParticipantTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.TestReport.TestReportResultEnumFactory

      class TestReportResultEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.TestReport.TestReportSetupComponent

      class TestReportSetupComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -123374486L

    • Class org.hl7.fhir.r5.model.TestReport.TestReportStatusEnumFactory

      class TestReportStatusEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.TestReport.TestReportTeardownComponent

      class TestReportTeardownComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1168638089L

    • Class org.hl7.fhir.r5.model.TestReport.TestReportTestComponent

      class TestReportTestComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -865006110L

      • Serialized Fields

        • action
          List<TestReport.TestActionComponent> action
          Action would contain either an operation or an assertion.
        • description
          StringType description
          A short description of the test used by test engines for tracking and reporting purposes.
        • name
          StringType name
          The name of this test used for tracking/logging purposes by test engines.

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

      class TestScript extends CanonicalResource implements Serializable
      serialVersionUID:
      1566648997L

      • 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 test script and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the test script.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the test script was last significantly changed. 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 test script changes.
        • description
          MarkdownType description
          A free text natural language description of the test script from a consumer's perspective.
        • destination
          List<TestScript.TestScriptDestinationComponent> destination
          An abstract server used in operations within this test script in the destination element.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this test script is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        • fixture
          List<TestScript.TestScriptFixtureComponent> fixture
          Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.
        • identifier
          List<Identifier> identifier
          A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance.
        • jurisdiction
          List<CodeableConcept> jurisdiction
          A legal or geographic region in which the test script is intended to be used.
        • metadata
          TestScript.TestScriptMetadataComponent metadata
          The required capability must exist and are assumed to function correctly on the FHIR server being tested.
        • name
          StringType name
          A natural language name identifying the test script. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        • origin
          List<TestScript.TestScriptOriginComponent> origin
          An abstract server used in operations within this test script in the origin element.
        • profile
          List<CanonicalType> profile
          Reference to the profile to be used for validation.
        • publisher
          StringType publisher
          The name of the organization or individual responsible for the release and ongoing maintenance of the test script.
        • purpose
          MarkdownType purpose
          Explanation of why this test script is needed and why it has been designed as it has.
        • scope
          List<TestScript.TestScriptScopeComponent> scope
          The scope indicates a conformance artifact that is tested by the test(s) within this test case and the expectation of the test outcome(s) as well as the intended test phase inclusion.
        • setup
          TestScript.TestScriptSetupComponent setup
          A series of required setup operations before tests are executed.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this test script. Enables tracking the life-cycle of the content.
        • teardown
          TestScript.TestScriptTeardownComponent teardown
          A series of operations required to clean up after all the tests are executed (successfully or otherwise).
        • test
          List<TestScript.TestScriptTestComponent> test
          A test in this script.
        • title
          StringType title
          A short, descriptive, user-friendly title for the test script.
        • url
          UriType url
          An absolute URI that is used to identify this test script 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 an authoritative instance of this test script is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the test script 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 test script instances.
        • variable
          List<TestScript.TestScriptVariableComponent> variable
          Variable is set based either on element value in response body or on header field value in the response headers.
        • version
          StringType version
          The identifier that is used to identify this version of the test script when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the test script 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which is more current.

    • Class org.hl7.fhir.r5.model.TestScript.AssertionDirectionTypeEnumFactory

      class AssertionDirectionTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.TestScript.AssertionManualCompletionTypeEnumFactory

      class AssertionManualCompletionTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.TestScript.AssertionOperatorTypeEnumFactory

      class AssertionOperatorTypeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.TestScript.AssertionResponseTypesEnumFactory

      class AssertionResponseTypesEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.TestScript.SetupActionAssertComponent

      class SetupActionAssertComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1269963728L

      • Serialized Fields

        • compareToSourceExpression
          StringType compareToSourceExpression
          The FHIRPath expression for a specific value to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.
        • compareToSourceId
          StringType compareToSourceId
          Id of the source fixture used as the contents to be evaluated by either the "source/expression" or "sourceId/path" definition.
        • compareToSourcePath
          StringType compareToSourcePath
          XPath or JSONPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.
        • contentType
          CodeType contentType
          The mime-type contents to compare against the request or response message 'Content-Type' header.
        • defaultManualCompletion
          Enumeration<TestScript.AssertionManualCompletionType> defaultManualCompletion
          The default manual completion outcome applied to this assertion.
        • description
          StringType description
          The description would be used by test engines for tracking and reporting purposes.
        • direction
          Enumeration<TestScript.AssertionDirectionType> direction
          The direction to use for the assertion.
        • expression
          StringType expression
          The FHIRPath expression to be evaluated against the request or response message contents - HTTP headers and payload.
        • headerField
          StringType headerField
          The HTTP header field name e.g. 'Location'.
        • label
          StringType label
          The label would be used for tracking/logging purposes by test engines.
        • minimumId
          StringType minimumId
          The ID of a fixture. Asserts that the response contains at a minimum the fixture specified by minimumId.
        • navigationLinks
          BooleanType navigationLinks
          Whether or not the test execution performs validation on the bundle navigation links.
        • operator
          Enumeration<TestScript.AssertionOperatorType> operator
          The operator type defines the conditional behavior of the assert.
        • path
          StringType path
          The XPath or JSONPath expression to be evaluated against the fixture representing the response received from server.
        • requestMethod
          Enumeration<TestScript.TestScriptRequestMethodCode> requestMethod
          The request method or HTTP operation code to compare against that used by the client system under test.
        • requestURL
          StringType requestURL
          The value to use in a comparison against the request URL path string.
        • requirement
          List<TestScript.SetupActionAssertRequirementComponent> requirement
          Links or references providing traceability to the testing requirements for this assert.
        • resource
          UriType resource
          The type of the resource. See the [resource list](resourcelist.html).
        • response
          Enumeration<TestScript.AssertionResponseTypes> response
          continue | switchingProtocols | okay | created | accepted | nonAuthoritativeInformation | noContent | resetContent | partialContent | multipleChoices | movedPermanently | found | seeOther | notModified | useProxy | temporaryRedirect | permanentRedirect | badRequest | unauthorized | paymentRequired | forbidden | notFound | methodNotAllowed | notAcceptable | proxyAuthenticationRequired | requestTimeout | conflict | gone | lengthRequired | preconditionFailed | contentTooLarge | uriTooLong | unsupportedMediaType | rangeNotSatisfiable | expectationFailed | misdirectedRequest | unprocessableContent | upgradeRequired | internalServerError | notImplemented | badGateway | serviceUnavailable | gatewayTimeout | httpVersionNotSupported.
        • responseCode
          StringType responseCode
          The value of the HTTP response code to be tested.
        • sourceId
          IdType sourceId
          Fixture to evaluate the XPath/JSONPath expression or the headerField against.
        • stopTestOnFail
          BooleanType stopTestOnFail
          Whether or not the current test execution will stop on failure for this assert.
        • validateProfileId
          IdType validateProfileId
          The ID of the Profile to validate against.
        • value
          StringType value
          The value to compare to.
        • warningOnly
          BooleanType warningOnly
          Whether or not the test execution will produce a warning only on error for this assert.

    • Class org.hl7.fhir.r5.model.TestScript.SetupActionAssertRequirementComponent

      class SetupActionAssertRequirementComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -91187948L

      • Serialized Fields

        • link
          DataType link
          Link or reference providing traceability to the testing requirement for this test.

    • Class org.hl7.fhir.r5.model.TestScript.SetupActionComponent

      class SetupActionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -252088305L

    • Class org.hl7.fhir.r5.model.TestScript.SetupActionOperationComponent

      class SetupActionOperationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      308704897L

      • Serialized Fields

        • accept
          CodeType accept
          The mime-type to use for RESTful operation in the 'Accept' header.
        • contentType
          CodeType contentType
          The mime-type to use for RESTful operation in the 'Content-Type' header.
        • description
          StringType description
          The description would be used by test engines for tracking and reporting purposes.
        • destination
          IntegerType destination
          The server where the request message is destined for. Must be one of the server numbers listed in TestScript.destination section.
        • encodeRequestUrl
          BooleanType encodeRequestUrl
          Whether or not to implicitly send the request url in encoded format. The default is true to match the standard RESTful client behavior. Set to false when communicating with a server that does not support encoded url paths.
        • label
          StringType label
          The label would be used for tracking/logging purposes by test engines.
        • method
          Enumeration<TestScript.TestScriptRequestMethodCode> method
          The HTTP method the test engine MUST use for this operation regardless of any other operation details.
        • origin
          IntegerType origin
          The server where the request message originates from. Must be one of the server numbers listed in TestScript.origin section.
        • params
          StringType params
          Path plus parameters after [type]. Used to set parts of the request URL explicitly.
        • requestHeader
          List<TestScript.SetupActionOperationRequestHeaderComponent> requestHeader
          Header elements would be used to set HTTP headers.
        • requestId
          IdType requestId
          The fixture id (maybe new) to map to the request.
        • resource
          UriType resource
          The type of the FHIR resource. See the [resource list](resourcelist.html). Data type of uri is needed when non-HL7 artifacts are identified.
        • responseId
          IdType responseId
          The fixture id (maybe new) to map to the response.
        • sourceId
          IdType sourceId
          The id of the fixture used as the body of a PUT or POST request.
        • targetId
          IdType targetId
          Id of fixture used for extracting the [id], [type], and [vid] for GET requests.
        • type
          Coding type
          Server interaction or operation type.
        • url
          StringType url
          Complete request URL.

    • Class org.hl7.fhir.r5.model.TestScript.SetupActionOperationRequestHeaderComponent

      class SetupActionOperationRequestHeaderComponent extends BackboneElement implements Serializable
      serialVersionUID:
      274395337L

      • Serialized Fields

        • field
          StringType field
          The HTTP header field e.g. "Accept".
        • value
          StringType value
          The value of the header e.g. "application/fhir+xml".

    • Class org.hl7.fhir.r5.model.TestScript.TeardownActionComponent

      class TeardownActionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1099598054L

    • Class org.hl7.fhir.r5.model.TestScript.TestActionComponent

      class TestActionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -252088305L

    • Class org.hl7.fhir.r5.model.TestScript.TestScriptDestinationComponent

      class TestScriptDestinationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -188072923L

      • Serialized Fields

        • index
          IntegerType index
          Abstract name given to a destination server in this test script. The name is provided as a number starting at 1.
        • profile
          Coding profile
          The type of destination profile the test system supports.
        • url
          UrlType url
          The explicit url path of the destination server used in this test script.

    • Class org.hl7.fhir.r5.model.TestScript.TestScriptFixtureComponent

      class TestScriptFixtureComponent extends BackboneElement implements Serializable
      serialVersionUID:
      672117234L

      • Serialized Fields

        • autocreate
          BooleanType autocreate
          Whether or not to implicitly create the fixture during setup. If true, the fixture is automatically created on each server being tested during setup, therefore no create operation is required for this fixture in the TestScript.setup section.
        • autodelete
          BooleanType autodelete
          Whether or not to implicitly delete the fixture during teardown. If true, the fixture is automatically deleted on each server being tested during teardown, therefore no delete operation is required for this fixture in the TestScript.teardown section.
        • resource
          Reference resource
          Reference to the resource (containing the contents of the resource needed for operations). This is allowed to be a Parameters resource.

    • Class org.hl7.fhir.r5.model.TestScript.TestScriptMetadataCapabilityComponent

      class TestScriptMetadataCapabilityComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1368199288L

      • Serialized Fields

        • capabilities
          CanonicalType capabilities
          Minimum capabilities required of server for test script to execute successfully. If server does not meet at a minimum the referenced capability statement, then all tests in this script are skipped.
        • description
          StringType description
          Description of the capabilities that this test script is requiring the server to support.
        • destination
          IntegerType destination
          Which server these requirements apply to.
        • link
          List<UriType> link
          Links to the FHIR specification that describes this interaction and the resources involved in more detail.
        • origin
          List<IntegerType> origin
          Which origin server these requirements apply to.
        • required
          BooleanType required
          Whether or not the test execution will require the given capabilities of the server in order for this test script to execute.
        • validated
          BooleanType validated
          Whether or not the test execution will validate the given capabilities of the server in order for this test script to execute.

    • Class org.hl7.fhir.r5.model.TestScript.TestScriptMetadataComponent

      class TestScriptMetadataComponent extends BackboneElement implements Serializable
      serialVersionUID:
      745183328L

    • Class org.hl7.fhir.r5.model.TestScript.TestScriptMetadataLinkComponent

      class TestScriptMetadataLinkComponent extends BackboneElement implements Serializable
      serialVersionUID:
      213372298L

      • Serialized Fields

        • description
          StringType description
          Short description of the link.
        • url
          UriType url
          URL to a particular requirement or feature within the FHIR specification.

    • Class org.hl7.fhir.r5.model.TestScript.TestScriptOriginComponent

      class TestScriptOriginComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -188072923L

      • Serialized Fields

        • index
          IntegerType index
          Abstract name given to an origin server in this test script. The name is provided as a number starting at 1.
        • profile
          Coding profile
          The type of origin profile the test system supports.
        • url
          UrlType url
          The explicit url path of the origin server used in this test script.

    • Class org.hl7.fhir.r5.model.TestScript.TestScriptRequestMethodCodeEnumFactory

      class TestScriptRequestMethodCodeEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.TestScript.TestScriptScopeComponent

      class TestScriptScopeComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1236847076L

      • Serialized Fields

        • artifact
          CanonicalType artifact
          The specific conformance artifact being tested. The canonical reference can be version-specific.
        • conformance
          CodeableConcept conformance
          The expectation of whether the test must pass for the system to be considered conformant with the artifact: required - all tests are expected to pass, optional - all test are expected to pass but non-pass status may be allowed, strict - all tests are expected to pass and warnings are treated as a failure.
        • phase
          CodeableConcept phase
          The phase of testing for this artifact: unit - development / implementation phase, integration - internal system to system phase, production - live system to system phase (Note, this may involve pii/phi data).

    • Class org.hl7.fhir.r5.model.TestScript.TestScriptSetupComponent

      class TestScriptSetupComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -123374486L

    • Class org.hl7.fhir.r5.model.TestScript.TestScriptTeardownComponent

      class TestScriptTeardownComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1168638089L

    • Class org.hl7.fhir.r5.model.TestScript.TestScriptTestComponent

      class TestScriptTestComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -865006110L

      • Serialized Fields

        • action
          List<TestScript.TestActionComponent> action
          Action would contain either an operation or an assertion.
        • description
          StringType description
          A short description of the test used by test engines for tracking and reporting purposes.
        • name
          StringType name
          The name of this test used for tracking/logging purposes by test engines.

    • Class org.hl7.fhir.r5.model.TestScript.TestScriptVariableComponent

      class TestScriptVariableComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1592325432L

      • Serialized Fields

        • defaultValue
          StringType defaultValue
          A default, hard-coded, or user-defined value for this variable.
        • description
          StringType description
          A free text natural language description of the variable and its purpose.
        • expression
          StringType expression
          The FHIRPath expression for a specific value to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.
        • headerField
          StringType headerField
          Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.
        • hint
          StringType hint
          Displayable text string with hint help information to the user when entering a default value.
        • name
          StringType name
          Descriptive name for this variable.
        • path
          StringType path
          XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.
        • sourceId
          IdType sourceId
          Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.

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

      class TimeType extends PrimitiveType<String> implements Externalizable
      serialVersionUID:
      3L

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

      class Timing extends BackboneType implements Serializable
      serialVersionUID:
      791565112L

      • Serialized Fields

        • code
          CodeableConcept code
          A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).
        • event
          List<DateTimeType> event
          Identifies specific times when the event occurs.
        • repeat
          Timing.TimingRepeatComponent repeat
          A set of rules that describe when the event is scheduled.

    • Class org.hl7.fhir.r5.model.Timing.EventTimingEnumFactory

      class EventTimingEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Timing.TimingRepeatComponent

      class TimingRepeatComponent extends Element implements Serializable
      serialVersionUID:
      -122116223L

      • Serialized Fields

        • bounds
          DataType bounds
          Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.
        • count
          PositiveIntType count
          A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.
        • countMax
          PositiveIntType countMax
          If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.
        • dayOfWeek
          List<Enumeration<Enumerations.DaysOfWeek>> dayOfWeek
          If one or more days of week is provided, then the action happens only on the specified day(s).
        • duration
          DecimalType duration
          How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.
        • durationMax
          DecimalType durationMax
          If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.
        • durationUnit
          Enumeration<Timing.UnitsOfTime> durationUnit
          The units of time for the duration, in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.
        • frequency
          PositiveIntType frequency
          The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.
        • frequencyMax
          PositiveIntType frequencyMax
          If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.
        • offset
          UnsignedIntType offset
          The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.
        • period
          DecimalType period
          Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.
        • periodMax
          DecimalType periodMax
          If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.
        • periodUnit
          Enumeration<Timing.UnitsOfTime> periodUnit
          The units of time for the period in UCUM units Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.
        • timeOfDay
          List<TimeType> timeOfDay
          Specified time of day for action to take place.
        • when
          List<Enumeration<Timing.EventTiming>> when
          An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.

    • Class org.hl7.fhir.r5.model.Timing.UnitsOfTimeEnumFactory

      class UnitsOfTimeEnumFactory extends Object implements Serializable

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

      class Transport extends DomainResource implements Serializable
      serialVersionUID:
      -2095581755L

      • Serialized Fields

        • authoredOn
          DateTimeType authoredOn
          The date and time this transport was created.
        • basedOn
          List<Reference> basedOn
          BasedOn refers to a higher-level authorization that triggered the creation of the transport. It references a "request" resource such as a ServiceRequest or Transport, which is distinct from the "request" resource the Transport is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a transport is created to fulfill a procedureRequest ( = FocusOn ) to transport a specimen to the lab.
        • code
          CodeableConcept code
          A name or code (or both) briefly describing what the transport involves.
        • completionTime
          DateTimeType completionTime
          Identifies the completion time of the event (the occurrence).
        • currentLocation
          Reference currentLocation
          The current location for the entity to be transported.
        • description
          StringType description
          A free-text description of what is to be performed.
        • encounter
          Reference encounter
          The healthcare event (e.g. a patient and healthcare provider interaction) during which this transport was created.
        • focus
          Reference focus
          The request being actioned or the resource being manipulated by this transport.
        • for_
          Reference for_
          The entity who benefits from the performance of the service specified in the transport (e.g., the patient).
        • groupIdentifier
          Identifier groupIdentifier
          A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.
        • history
          Reference history
          The transport event prior to this one.
        • identifier
          List<Identifier> identifier
          Identifier for the transport event that is used to identify it across multiple disparate systems.
        • input
          List<Transport.ParameterComponent> input
          Additional information that may be needed in the execution of the transport.
        • instantiatesCanonical
          CanonicalType instantiatesCanonical
          The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Transport.
        • instantiatesUri
          UriType instantiatesUri
          The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Transport.
        • insurance
          List<Reference> insurance
          Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Transport.
        • intent
          Enumeration<Transport.TransportIntent> intent
          Indicates the "level" of actionability associated with the Transport, i.e. i+R[9]Cs this a proposed transport, a planned transport, an actionable transport, etc.
        • lastModified
          DateTimeType lastModified
          The date and time of last modification to this transport.
        • location
          Reference location
          Principal physical location where this transport is performed.
        • note
          List<Annotation> note
          Free-text information captured about the transport as it progresses.
        • output
          List<Transport.TransportOutputComponent> output
          Outputs produced by the Transport.
        • owner
          Reference owner
          Individual organization or Device currently responsible for transport execution.
        • partOf
          List<Reference> partOf
          A larger event of which this particular event is a component or step.
        • performerType
          List<CodeableConcept> performerType
          The kind of participant that should perform the transport.
        • priority
          Enumeration<Enumerations.RequestPriority> priority
          Indicates how quickly the Transport should be addressed with respect to other requests.
        • reason
          CodeableReference reason
          A resource reference indicating why this transport needs to be performed.
        • relevantHistory
          List<Reference> relevantHistory
          Links to Provenance records for past versions of this Transport that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the transport.
        • requestedLocation
          Reference requestedLocation
          The desired or final location for the transport.
        • requester
          Reference requester
          The creator of the transport.
        • restriction
          Transport.TransportRestrictionComponent restriction
          If the Transport.focus is a request resource and the transport is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.
        • status
          Enumeration<Transport.TransportStatus> status
          A code specifying the state of the transport event.
        • statusReason
          CodeableConcept statusReason
          An explanation as to why this transport is held, failed, was refused, etc.

    • Class org.hl7.fhir.r5.model.Transport.ParameterComponent

      class ParameterComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1659186716L

      • Serialized Fields

        • type
          CodeableConcept type
          A code or description indicating how the input is intended to be used as part of the transport execution.
        • value
          DataType value
          The value of the input parameter as a basic type.

    • Class org.hl7.fhir.r5.model.Transport.TransportIntentEnumFactory

      class TransportIntentEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.Transport.TransportOutputComponent

      class TransportOutputComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1659186716L

      • Serialized Fields

        • type
          CodeableConcept type
          The name of the Output parameter.
        • value
          DataType value
          The value of the Output parameter as a basic type.

    • Class org.hl7.fhir.r5.model.Transport.TransportRestrictionComponent

      class TransportRestrictionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1673996066L

      • Serialized Fields

        • period
          Period period
          Over what time-period is fulfillment sought.
        • recipient
          List<Reference> recipient
          For requests that are targeted to more than one potential recipient/target, to identify who is fulfillment is sought for.
        • repetitions
          PositiveIntType repetitions
          Indicates the number of times the requested action should occur.

    • Class org.hl7.fhir.r5.model.Transport.TransportStatusEnumFactory

      class TransportStatusEnumFactory extends Object implements Serializable

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

      class TriggerDefinition extends DataType implements Serializable
      serialVersionUID:
      -1823040479L

      • Serialized Fields

        • code
          CodeableConcept code
          A code that identifies the event.
        • condition
          Expression condition
          A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.
        • data
          List<DataRequirement> data
          The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.
        • name
          StringType name
          A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.
        • subscriptionTopic
          CanonicalType subscriptionTopic
          A reference to a SubscriptionTopic resource that defines the event. If this element is provided, no other information about the trigger definition may be supplied.
        • timing
          DataType timing
          The timing of the event (if this is a periodic trigger).
        • type
          Enumeration<TriggerDefinition.TriggerType> type
          The type of triggering event.

    • Class org.hl7.fhir.r5.model.TriggerDefinition.TriggerTypeEnumFactory

      class TriggerTypeEnumFactory extends Object implements Serializable

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

      class Tuple extends Base implements Serializable
      serialVersionUID:
      -8402411970797277451L

      • Serialized Fields

        • properties
          Map<String,List<Base>> properties
        • publicationVersion
          org.hl7.fhir.utilities.FhirPublication publicationVersion

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

      class UnsignedIntType extends IntegerType implements Externalizable
      serialVersionUID:
      -7991875974606711355L

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

      class UriType extends PrimitiveType<String> implements Externalizable
      serialVersionUID:
      3L

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

      class UrlType extends UriType implements Externalizable
      serialVersionUID:
      4L

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

      class UsageContext extends DataType implements Serializable
      serialVersionUID:
      -1546390646L

      • Serialized Fields

        • code
          Coding code
          A code that identifies the type of context being specified by this usage context.
        • value
          DataType value
          A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

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

      class UuidType extends UriType implements Externalizable
      serialVersionUID:
      3L

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

      class ValueSet extends MetadataResource implements Serializable
      serialVersionUID:
      -1050676231L

      • 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 ValueSet.
        • compose
          ValueSet.ValueSetComposeComponent compose
          A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).
        • 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 value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.
        • copyrightLabel
          StringType copyrightLabel
          A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
        • date
          DateTimeType date
          The date (and optionally time) when the value set metadata or content logical definition (.compose) was created or revised.
        • description
          MarkdownType description
          A free text natural language description of the value set from a consumer's perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of the Value Set.
        • editor
          List<ContactDetail> editor
          An individual or organization primarily responsible for internal coherence of the ValueSet.
        • effectivePeriod
          Period effectivePeriod
          The period during which the ValueSet content was or is planned to be in active use.
        • endorser
          List<ContactDetail> endorser
          An individual or organization asserted by the publisher to be responsible for officially endorsing the ValueSet for use in some setting.
        • expansion
          ValueSet.ValueSetExpansionComponent expansion
          A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.
        • experimental
          BooleanType experimental
          A Boolean value to indicate that this value set 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 value set when it is represented in other formats, or referenced in a specification, model, design or an instance.
        • immutable
          BooleanType immutable
          If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.
        • jurisdiction
          List<CodeableConcept> jurisdiction
          A legal or geographic region in which the value set 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 value set. 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 responsible for the release and ongoing maintenance of the value set.
        • purpose
          MarkdownType purpose
          Explanation of why this value set is needed and why it has been designed as it has.
        • relatedArtifact
          List<RelatedArtifact> relatedArtifact
          Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.
        • reviewer
          List<ContactDetail> reviewer
          An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ValueSet.
        • scope
          ValueSet.ValueSetScopeComponent scope
          Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description.
        • status
          Enumeration<Enumerations.PublicationStatus> status
          The status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state.
        • title
          StringType title
          A short, descriptive, user-friendly title for the value set.
        • topic
          List<CodeableConcept> topic
          Descriptions related to the content of the ValueSet. Topics provide a high-level categorization as well as keywords for the ValueSet that can be useful for filtering and searching.
        • url
          UriType url
          An absolute URI that is used to identify this value set 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 an authoritative instance of this value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set 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 value set instances.
        • version
          StringType version
          The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set 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.
        • versionAlgorithm
          DataType versionAlgorithm
          Indicates the mechanism used to compare versions to determine which ValueSet is more current.

    • Class org.hl7.fhir.r5.model.ValueSet.ConceptPropertyComponent

      class ConceptPropertyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -948620650L

    • Class org.hl7.fhir.r5.model.ValueSet.ConceptReferenceComponent

      class ConceptReferenceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      260579971L

      • Serialized Fields

        • code
          CodeType code
          Specifies a code for the concept to be included or excluded.
        • designation
          List<ValueSet.ConceptReferenceDesignationComponent> designation
          Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc.
        • display
          StringType display
          The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system.

    • Class org.hl7.fhir.r5.model.ValueSet.ConceptReferenceDesignationComponent

      class ConceptReferenceDesignationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -141147882L

      • Serialized Fields

        • additionalUse
          List<Coding> additionalUse
          Additional codes that detail how this designation would be used, if there is more than one use.
        • language
          CodeType language
          The language this designation is defined for.
        • use
          Coding use
          A code that represents types of uses of designations.
        • value
          StringType value
          The text value for this designation.

    • Class org.hl7.fhir.r5.model.ValueSet.ConceptSetComponent

      class ConceptSetComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -517139062L

      • Serialized Fields

        • concept
          List<ValueSet.ConceptReferenceComponent> concept
          Specifies a concept to be included or excluded.
        • copyright
          StringType copyright
          A copyright statement for the specific code system asserted by the containing ValueSet.compose.include element's system value (if the associated ValueSet.compose.include.version element is not present); or the code system and version combination (if the associated ValueSet.compose.include.version element is present).
        • filter
          List<ValueSet.ConceptSetFilterComponent> filter
          Select concepts by specifying a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified within the include, they SHALL all be true.
        • system
          UriType system
          An absolute URI which is the code system from which the selected codes come from.
        • valueSet
          List<CanonicalType> valueSet
          Selects the concepts found in this value set (based on its value set definition). This is an absolute URI that is a reference to ValueSet.url. If multiple value sets are specified this includes the intersection of the contents of all of the referenced value sets.
        • version
          StringType version
          The version of the code system that the codes are selected from, or the special version '*' for all versions.

    • Class org.hl7.fhir.r5.model.ValueSet.ConceptSetFilterComponent

      class ConceptSetFilterComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1259153492L

      • Serialized Fields

        • op
          Enumeration<Enumerations.FilterOperator> op
          The kind of operation to perform as a part of the filter criteria.
        • property
          CodeType property
          A code that identifies a property or a filter defined in the code system.
        • value
          StringType value
          The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value (if the filter represents a property defined in CodeSystem) or of the system filter value (if the filter represents a filter defined in CodeSystem) when the operation is 'regex', or one of the values (true and false), when the operation is 'exists'.

    • Class org.hl7.fhir.r5.model.ValueSet.ConceptSubPropertyComponent

      class ConceptSubPropertyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -422546419L

      • Serialized Fields

        • code
          CodeType code
          A code that is a reference to ValueSet.expansion.property.code.
        • value
          DataType value
          The value of this subproperty.

    • Class org.hl7.fhir.r5.model.ValueSet.ValueSetComposeComponent

      class ValueSetComposeComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -15414259L

      • Serialized Fields

        • exclude
          List<ValueSet.ConceptSetComponent> exclude
          Exclude one or more codes from the value set based on code system filters and/or other value sets.
        • inactive
          BooleanType inactive
          Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included).
        • include
          List<ValueSet.ConceptSetComponent> include
          Include one or more codes from a code system or other value set(s).
        • lockedDate
          DateType lockedDate
          The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version.
        • property
          List<StringType> property
          A property to return in the expansion, if the client doesn't ask for any particular properties. May be either a code from the code system definition (convenient) or a the formal URI that refers to the property. The special value '*' means all properties known to the server.

    • Class org.hl7.fhir.r5.model.ValueSet.ValueSetExpansionComponent

      class ValueSetExpansionComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1141573269L

      • Serialized Fields

        • contains
          List<ValueSet.ValueSetExpansionContainsComponent> contains
          The codes that are contained in the value set expansion.
        • identifier
          UriType identifier
          An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier.
        • next
          UriType next
          As per paging Search results, the next URLs are opaque to the client, have no dictated structure, and only the server understands them.
        • offset
          IntegerType offset
          If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL NOT be present.
        • parameter
          List<ValueSet.ValueSetExpansionParameterComponent> parameter
          A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion.
        • property
          List<ValueSet.ValueSetExpansionPropertyComponent> property
          A property defines an additional slot through which additional information can be provided about a concept.
        • timestamp
          DateTimeType timestamp
          The time at which the expansion was produced by the expanding system.
        • total
          IntegerType total
          The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter.

    • Class org.hl7.fhir.r5.model.ValueSet.ValueSetExpansionContainsComponent

      class ValueSetExpansionContainsComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1370569439L

      • Serialized Fields

        • abstract_
          BooleanType abstract_
          If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.
        • code
          CodeType code
          The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.
        • contains
          List<ValueSet.ValueSetExpansionContainsComponent> contains
          Other codes and entries contained under this entry in the hierarchy.
        • designation
          List<ValueSet.ConceptReferenceDesignationComponent> designation
          Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation.
        • display
          StringType display
          The recommended display for this item in the expansion.
        • inactive
          BooleanType inactive
          If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether a concept is inactive (and it may depend on the context of use).
        • property
          List<ValueSet.ConceptPropertyComponent> property
          A property value for this concept.
        • system
          UriType system
          An absolute URI which is the code system in which the code for this item in the expansion is defined.
        • version
          StringType version
          The version of the code system from this code was taken. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

    • Class org.hl7.fhir.r5.model.ValueSet.ValueSetExpansionParameterComponent

      class ValueSetExpansionParameterComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1839679495L

      • Serialized Fields

        • name
          StringType name
          Name of the input parameter to the $expand operation; may be a server-assigned name for additional default or other server-supplied parameters used to control the expansion process.
        • value
          DataType value
          The value of the parameter.

    • Class org.hl7.fhir.r5.model.ValueSet.ValueSetExpansionPropertyComponent

      class ValueSetExpansionPropertyComponent extends BackboneElement implements Serializable
      serialVersionUID:
      929575836L

      • Serialized Fields

        • code
          CodeType code
          A code that is used to identify the property. The code is used in ValueSet.expansion.contains.property.code.
        • 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.ValueSet.ValueSetScopeComponent

      class ValueSetScopeComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -641434610L

      • Serialized Fields

        • exclusionCriteria
          StringType exclusionCriteria
          Criteria describing which concepts or codes should be excluded and why.
        • inclusionCriteria
          StringType inclusionCriteria
          Criteria describing which concepts or codes should be included and why.

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

      class VerificationResult extends DomainResource implements Serializable
      serialVersionUID:
      -612905810L

    • Class org.hl7.fhir.r5.model.VerificationResult.VerificationResultAttestationComponent

      class VerificationResultAttestationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -1110142980L

      • Serialized Fields

        • communicationMethod
          CodeableConcept communicationMethod
          The method by which attested information was submitted/retrieved (manual; API; Push).
        • date
          DateType date
          The date the information was attested to.
        • onBehalfOf
          Reference onBehalfOf
          When the who is asserting on behalf of another (organization or individual).
        • proxyIdentityCertificate
          StringType proxyIdentityCertificate
          A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source.
        • proxySignature
          Signature proxySignature
          Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source.
        • sourceIdentityCertificate
          StringType sourceIdentityCertificate
          A digital identity certificate associated with the attestation source.
        • sourceSignature
          Signature sourceSignature
          Signed assertion by the attestation source that they have attested to the information.
        • who
          Reference who
          The individual or organization attesting to information.

    • Class org.hl7.fhir.r5.model.VerificationResult.VerificationResultPrimarySourceComponent

      class VerificationResultPrimarySourceComponent extends BackboneElement implements Serializable
      serialVersionUID:
      -266994197L

      • Serialized Fields

        • canPushUpdates
          CodeableConcept canPushUpdates
          Ability of the primary source to push updates/alerts (yes; no; undetermined).
        • communicationMethod
          List<CodeableConcept> communicationMethod
          Method for communicating with the primary source (manual; API; Push).
        • pushTypeAvailable
          List<CodeableConcept> pushTypeAvailable
          Type of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source).
        • type
          List<CodeableConcept> type
          Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source).
        • validationDate
          DateTimeType validationDate
          When the target was validated against the primary source.
        • validationStatus
          CodeableConcept validationStatus
          Status of the validation of the target against the primary source (successful; failed; unknown).
        • who
          Reference who
          Reference to the primary source.

    • Class org.hl7.fhir.r5.model.VerificationResult.VerificationResultStatusEnumFactory

      class VerificationResultStatusEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.VerificationResult.VerificationResultValidatorComponent

      class VerificationResultValidatorComponent extends BackboneElement implements Serializable
      serialVersionUID:
      335952370L

      • Serialized Fields

        • attestationSignature
          Signature attestationSignature
          Signed assertion by the validator that they have validated the information.
        • identityCertificate
          StringType identityCertificate
          A digital identity certificate associated with the validator.
        • organization
          Reference organization
          Reference to the organization validating information.

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

      class VirtualServiceDetail extends DataType implements Serializable
      serialVersionUID:
      -514931977L

      • Serialized Fields

        • additionalInfo
          List<UrlType> additionalInfo
          Address to see alternative connection details.
        • address
          DataType address
          What address or number needs to be used for a user to connect to the virtual service to join. The channelType informs as to which datatype is appropriate to use (requires knowledge of the specific type).
        • channelType
          Coding channelType
          The type of virtual service to connect to (i.e. Teams, Zoom, Specific VMR technology, WhatsApp).
        • maxParticipants
          PositiveIntType maxParticipants
          Maximum number of participants supported by the virtual service.
        • sessionKey
          StringType sessionKey
          Session Key required by the virtual service.

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

      class VisionPrescription extends DomainResource implements Serializable
      serialVersionUID:
      -194296688L

      • Serialized Fields

        • created
          DateTimeType created
          The date this resource was created.
        • dateWritten
          DateTimeType dateWritten
          The date (and perhaps time) when the prescription was written.
        • encounter
          Reference encounter
          A reference to a resource that identifies the particular occurrence of contact between patient and health care provider during which the prescription was issued.
        • identifier
          List<Identifier> identifier
          A unique identifier assigned to this vision prescription.
        • lensSpecification
          List<VisionPrescription.VisionPrescriptionLensSpecificationComponent> lensSpecification
          Contain the details of the individual lens specifications and serves as the authorization for the fullfillment by certified professionals.
        • patient
          Reference patient
          A resource reference to the person to whom the vision prescription applies.
        • prescriber
          Reference prescriber
          The healthcare professional responsible for authorizing the prescription.
        • status
          Enumeration<Enumerations.FinancialResourceStatusCodes> status
          The status of the resource instance.

    • Class org.hl7.fhir.r5.model.VisionPrescription.PrismComponent

      class PrismComponent extends BackboneElement implements Serializable
      serialVersionUID:
      1677247628L

    • Class org.hl7.fhir.r5.model.VisionPrescription.VisionBaseEnumFactory

      class VisionBaseEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.VisionPrescription.VisionEyesEnumFactory

      class VisionEyesEnumFactory extends Object implements Serializable

    • Class org.hl7.fhir.r5.model.VisionPrescription.VisionPrescriptionLensSpecificationComponent

      class VisionPrescriptionLensSpecificationComponent extends BackboneElement implements Serializable
      serialVersionUID:
      688924460L

      • Serialized Fields

        • add
          DecimalType add
          Power adjustment for multifocal lenses measured in dioptres (0.25 units).
        • axis
          IntegerType axis
          Adjustment for astigmatism measured in integer degrees.
        • backCurve
          DecimalType backCurve
          Back curvature measured in millimetres.
        • brand
          StringType brand
          Brand recommendations or restrictions.
        • color
          StringType color
          Special color or pattern.
        • cylinder
          DecimalType cylinder
          Power adjustment for astigmatism measured in dioptres (0.25 units).
        • diameter
          DecimalType diameter
          Contact lens diameter measured in millimetres.
        • duration
          Quantity duration
          The recommended maximum wear period for the lens.
        • eye
          Enumeration<VisionPrescription.VisionEyes> eye
          The eye for which the lens specification applies.
        • note
          List<Annotation> note
          Notes for special requirements such as coatings and lens materials.
        • power
          DecimalType power
          Contact lens power measured in dioptres (0.25 units).
        • prism
          List<VisionPrescription.PrismComponent> prism
          Allows for adjustment on two axis.
        • product
          CodeableConcept product
          Identifies the type of vision correction product which is required for the patient.
        • sphere
          DecimalType sphere
          Lens power measured in dioptres (0.25 units).

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

      class XhtmlType extends PrimitiveType<String> implements Externalizable

  • Package org.hl7.fhir.r5.patterns

  • Package org.hl7.fhir.r5.renderers

  • Package org.hl7.fhir.r5.terminologies.expansion

  • Package org.hl7.fhir.r5.terminologies.providers

  • Package org.hl7.fhir.r5.terminologies.utilities

  • Package org.hl7.fhir.r5.terminologies.validation

  • Package org.hl7.fhir.r5.utils

  • Package org.hl7.fhir.r5.utils.client