Uses of Class
com.ibm.fhir.model.type.Period

Packages that use Period

Package	Description
com.ibm.fhir.model.resource
com.ibm.fhir.model.type
com.ibm.fhir.model.visitor

Uses of Period in com.ibm.fhir.model.resource

Methods in com.ibm.fhir.model.resource that return Period

Modifier and Type	Method	Description
Period	Contract.getApplies()	Relevant time or time-period when this Contract is applicable.
Period	Contract.Term.getApplies()	Relevant time or time-period when this Contract Provision is applicable.
Period	CoverageEligibilityResponse.Insurance.getBenefitPeriod()	The term of the benefits documented in this response.
Period	ExplanationOfBenefit.getBenefitPeriod()	The term of the benefits documented in this response.
Period	Claim.getBillablePeriod()	The period for which charges are being submitted.
Period	ExplanationOfBenefit.getBillablePeriod()	The period for which charges are being submitted.
Period	MedicinalProductAuthorization.getDataExclusivityPeriod()	A period of time after authorization before generic product applicatiosn can be submitted.
Period	Consent.Provision.getDataPeriod()	Clinical or Operational Relevant period of time that bounds the data controlled by this rule.
Period	BiologicallyDerivedProduct.Storage.getDuration()	Storage timeperiod.
Period	HealthcareService.NotAvailable.getDuring()	Service is not available (seasonally or for a public holiday) from this date.
Period	PractitionerRole.NotAvailable.getDuring()	Service is not available (seasonally or for a public holiday) from this date.
Period	ActivityDefinition.getEffectivePeriod()	The period during which the activity definition content was or is planned to be in active use.
Period	ChargeItemDefinition.getEffectivePeriod()	The period during which the charge item definition content was or is planned to be in active use.
Period	EffectEvidenceSynthesis.getEffectivePeriod()	The period during which the effect evidence synthesis content was or is planned to be in active use.
Period	EventDefinition.getEffectivePeriod()	The period during which the event definition content was or is planned to be in active use.
Period	Evidence.getEffectivePeriod()	The period during which the evidence content was or is planned to be in active use.
Period	EvidenceVariable.getEffectivePeriod()	The period during which the evidence variable content was or is planned to be in active use.
Period	Library.getEffectivePeriod()	The period during which the library content was or is planned to be in active use.
Period	Measure.getEffectivePeriod()	The period during which the measure content was or is planned to be in active use.
Period	PlanDefinition.getEffectivePeriod()	The period during which the plan definition content was or is planned to be in active use.
Period	Questionnaire.getEffectivePeriod()	The period during which the questionnaire content was or is planned to be in active use.
Period	ResearchDefinition.getEffectivePeriod()	The period during which the research definition content was or is planned to be in active use.
Period	ResearchElementDefinition.getEffectivePeriod()	The period during which the research element definition content was or is planned to be in active use.
Period	RiskEvidenceSynthesis.getEffectivePeriod()	The period during which the risk evidence synthesis content was or is planned to be in active use.
Period	Task.getExecutionPeriod()	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).
Period	Account.Guarantor.getPeriod()	The timeframe during which the guarantor accepts responsibility for the account.
Period	Appointment.Participant.getPeriod()	Participation period of the actor.
Period	AuditEvent.getPeriod()	The period during which the activity occurred.
Period	CarePlan.getPeriod()	Indicates when the plan did (or is intended to) come into effect and end.
Period	CareTeam.getPeriod()	Indicates when the team did (or is intended to) come into effect and end.
Period	CareTeam.Participant.getPeriod()	Indicates when the specific member or organization did (or is intended to) come into effect and end.
Period	Composition.Event.getPeriod()	The period of time covered by the documentation.
Period	Consent.Provision.getPeriod()	The timeframe in this rule is valid.
Period	Coverage.CostToBeneficiary.Exception.getPeriod()	The timeframe during when the exception is in force.
Period	Coverage.getPeriod()	Time period during which the coverage is in force.
Period	DocumentReference.Context.getPeriod()	The time period over which the service that is described by the document was provided.
Period	Encounter.ClassHistory.getPeriod()	The time that the episode was in the specified class.
Period	Encounter.getPeriod()	The start and end time of the encounter.
Period	Encounter.Location.getPeriod()	Time period during which the patient was present at the location.
Period	Encounter.Participant.getPeriod()	The period of time that the specified participant participated in the encounter.
Period	Encounter.StatusHistory.getPeriod()	The time that the episode was in the specified status.
Period	Endpoint.getPeriod()	The interval during which the endpoint is expected to be operational.
Period	EpisodeOfCare.getPeriod()	The interval during which the managing organization assumes the defined responsibility.
Period	EpisodeOfCare.StatusHistory.getPeriod()	The period during this EpisodeOfCare that the specific status applied.
Period	Flag.getPeriod()	The period of time from the activation of the flag to inactivation of the flag.
Period	Group.Characteristic.getPeriod()	The period over which the characteristic is tested; e.g.
Period	Group.Member.getPeriod()	The period that the member was in the group, if known.
Period	InsurancePlan.getPeriod()	The period of time that the health insurance product is available.
Period	MeasureReport.getPeriod()	The reporting period for which the report was calculated.
Period	NamingSystem.UniqueId.getPeriod()	Identifies the period of time over which this identifier is considered appropriate to refer to the naming system.
Period	OrganizationAffiliation.getPeriod()	The period during which the participatingOrganization is affiliated with the primary organization.
Period	Patient.Contact.getPeriod()	The period during which this contact person or organization is valid to be contacted relating to this patient.
Period	PaymentReconciliation.getPeriod()	The period of time for which payments have been gathered into this bulk payment for settlement.
Period	Practitioner.Qualification.getPeriod()	Period during which the qualification is valid.
Period	PractitionerRole.getPeriod()	The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
Period	RelatedPerson.getPeriod()	The period of time during which this relationship is or was active.
Period	ResearchStudy.getPeriod()	Identifies the start date and the expected (or actual, depending on status) end date for the study.
Period	ResearchSubject.getPeriod()	The dates the subject began and ended their participation in the study.
Period	Task.Restriction.getPeriod()	Over what time-period is fulfillment sought.
Period	Schedule.getPlanningHorizon()	The period of time that the slots that reference this Schedule resource cover (even if none exist).
Period	ClaimResponse.getPreAuthPeriod()	The time frame during which this authorization is effective.
Period	Account.getServicePeriod()	The date range of services associated with this account.
Period	CatalogEntry.getValidityPeriod()	The time period in which this catalog entry is expected to be active.
Period	MedicationRequest.DispenseRequest.getValidityPeriod()	This indicates the validity period of a prescription (stale dating the Prescription).
Period	MedicinalProductAuthorization.getValidityPeriod()	The beginning of the time period in which the marketing authorization is in the specific status shall be specified A complete date consisting of day, month and year shall be specified using the ISO 8601 date format.
Period	MedicinalProductAuthorization.JurisdictionalAuthorization.getValidityPeriod()	The start and expected end date of the authorization.

Methods in com.ibm.fhir.model.resource that return types with arguments of type Period

Modifier and Type	Method	Description
List<Period>	Contract.Term.Asset.getPeriod()	Asset relevant contractual time period.
List<Period>	ExplanationOfBenefit.getPreAuthRefPeriod()	The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided.
List<Period>	Appointment.getRequestedPeriod()	A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.
List<Period>	Contract.Term.Asset.getUsePeriod()	Time period of asset use.

Methods in com.ibm.fhir.model.resource with parameters of type Period

Modifier and Type	Method	Description
Contract.Builder	Contract.Builder.applies(Period applies)	Relevant time or time-period when this Contract is applicable.
Contract.Term.Builder	Contract.Term.Builder.applies(Period applies)	Relevant time or time-period when this Contract Provision is applicable.
CoverageEligibilityResponse.Insurance.Builder	CoverageEligibilityResponse.Insurance.Builder.benefitPeriod(Period benefitPeriod)	The term of the benefits documented in this response.
ExplanationOfBenefit.Builder	ExplanationOfBenefit.Builder.benefitPeriod(Period benefitPeriod)	The term of the benefits documented in this response.
Claim.Builder	Claim.Builder.billablePeriod(Period billablePeriod)	The period for which charges are being submitted.
ExplanationOfBenefit.Builder	ExplanationOfBenefit.Builder.billablePeriod(Period billablePeriod)	The period for which charges are being submitted.
MedicinalProductAuthorization.Builder	MedicinalProductAuthorization.Builder.dataExclusivityPeriod(Period dataExclusivityPeriod)	A period of time after authorization before generic product applicatiosn can be submitted.
Consent.Provision.Builder	Consent.Provision.Builder.dataPeriod(Period dataPeriod)	Clinical or Operational Relevant period of time that bounds the data controlled by this rule.
BiologicallyDerivedProduct.Storage.Builder	BiologicallyDerivedProduct.Storage.Builder.duration(Period duration)	Storage timeperiod.
HealthcareService.NotAvailable.Builder	HealthcareService.NotAvailable.Builder.during(Period during)	Service is not available (seasonally or for a public holiday) from this date.
PractitionerRole.NotAvailable.Builder	PractitionerRole.NotAvailable.Builder.during(Period during)	Service is not available (seasonally or for a public holiday) from this date.
ActivityDefinition.Builder	ActivityDefinition.Builder.effectivePeriod(Period effectivePeriod)	The period during which the activity definition content was or is planned to be in active use.
ChargeItemDefinition.Builder	ChargeItemDefinition.Builder.effectivePeriod(Period effectivePeriod)	The period during which the charge item definition content was or is planned to be in active use.
EffectEvidenceSynthesis.Builder	EffectEvidenceSynthesis.Builder.effectivePeriod(Period effectivePeriod)	The period during which the effect evidence synthesis content was or is planned to be in active use.
EventDefinition.Builder	EventDefinition.Builder.effectivePeriod(Period effectivePeriod)	The period during which the event definition content was or is planned to be in active use.
Evidence.Builder	Evidence.Builder.effectivePeriod(Period effectivePeriod)	The period during which the evidence content was or is planned to be in active use.
EvidenceVariable.Builder	EvidenceVariable.Builder.effectivePeriod(Period effectivePeriod)	The period during which the evidence variable content was or is planned to be in active use.
Library.Builder	Library.Builder.effectivePeriod(Period effectivePeriod)	The period during which the library content was or is planned to be in active use.
Measure.Builder	Measure.Builder.effectivePeriod(Period effectivePeriod)	The period during which the measure content was or is planned to be in active use.
PlanDefinition.Builder	PlanDefinition.Builder.effectivePeriod(Period effectivePeriod)	The period during which the plan definition content was or is planned to be in active use.
Questionnaire.Builder	Questionnaire.Builder.effectivePeriod(Period effectivePeriod)	The period during which the questionnaire content was or is planned to be in active use.
ResearchDefinition.Builder	ResearchDefinition.Builder.effectivePeriod(Period effectivePeriod)	The period during which the research definition content was or is planned to be in active use.
ResearchElementDefinition.Builder	ResearchElementDefinition.Builder.effectivePeriod(Period effectivePeriod)	The period during which the research element definition content was or is planned to be in active use.
RiskEvidenceSynthesis.Builder	RiskEvidenceSynthesis.Builder.effectivePeriod(Period effectivePeriod)	The period during which the risk evidence synthesis content was or is planned to be in active use.
Task.Builder	Task.Builder.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).
Account.Guarantor.Builder	Account.Guarantor.Builder.period(Period period)	The timeframe during which the guarantor accepts responsibility for the account.
Appointment.Participant.Builder	Appointment.Participant.Builder.period(Period period)	Participation period of the actor.
AuditEvent.Builder	AuditEvent.Builder.period(Period period)	The period during which the activity occurred.
CarePlan.Builder	CarePlan.Builder.period(Period period)	Indicates when the plan did (or is intended to) come into effect and end.
CareTeam.Builder	CareTeam.Builder.period(Period period)	Indicates when the team did (or is intended to) come into effect and end.
CareTeam.Participant.Builder	CareTeam.Participant.Builder.period(Period period)	Indicates when the specific member or organization did (or is intended to) come into effect and end.
Composition.Event.Builder	Composition.Event.Builder.period(Period period)	The period of time covered by the documentation.
Consent.Provision.Builder	Consent.Provision.Builder.period(Period period)	The timeframe in this rule is valid.
Contract.Term.Asset.Builder	Contract.Term.Asset.Builder.period(Period... period)	Asset relevant contractual time period.
Coverage.Builder	Coverage.Builder.period(Period period)	Time period during which the coverage is in force.
Coverage.CostToBeneficiary.Exception.Builder	Coverage.CostToBeneficiary.Exception.Builder.period(Period period)	The timeframe during when the exception is in force.
DocumentReference.Context.Builder	DocumentReference.Context.Builder.period(Period period)	The time period over which the service that is described by the document was provided.
Encounter.Builder	Encounter.Builder.period(Period period)	The start and end time of the encounter.
Encounter.ClassHistory.Builder	Encounter.ClassHistory.Builder.period(Period period)	The time that the episode was in the specified class.
Encounter.Location.Builder	Encounter.Location.Builder.period(Period period)	Time period during which the patient was present at the location.
Encounter.Participant.Builder	Encounter.Participant.Builder.period(Period period)	The period of time that the specified participant participated in the encounter.
Encounter.StatusHistory.Builder	Encounter.StatusHistory.Builder.period(Period period)	The time that the episode was in the specified status.
Endpoint.Builder	Endpoint.Builder.period(Period period)	The interval during which the endpoint is expected to be operational.
EpisodeOfCare.Builder	EpisodeOfCare.Builder.period(Period period)	The interval during which the managing organization assumes the defined responsibility.
EpisodeOfCare.StatusHistory.Builder	EpisodeOfCare.StatusHistory.Builder.period(Period period)	The period during this EpisodeOfCare that the specific status applied.
Flag.Builder	Flag.Builder.period(Period period)	The period of time from the activation of the flag to inactivation of the flag.
Group.Characteristic.Builder	Group.Characteristic.Builder.period(Period period)	The period over which the characteristic is tested; e.g.
Group.Member.Builder	Group.Member.Builder.period(Period period)	The period that the member was in the group, if known.
InsurancePlan.Builder	InsurancePlan.Builder.period(Period period)	The period of time that the health insurance product is available.
MeasureReport.Builder	MeasureReport.Builder.period(Period period)	The reporting period for which the report was calculated.
NamingSystem.UniqueId.Builder	NamingSystem.UniqueId.Builder.period(Period period)	Identifies the period of time over which this identifier is considered appropriate to refer to the naming system.
OrganizationAffiliation.Builder	OrganizationAffiliation.Builder.period(Period period)	The period during which the participatingOrganization is affiliated with the primary organization.
Patient.Contact.Builder	Patient.Contact.Builder.period(Period period)	The period during which this contact person or organization is valid to be contacted relating to this patient.
PaymentReconciliation.Builder	PaymentReconciliation.Builder.period(Period period)	The period of time for which payments have been gathered into this bulk payment for settlement.
Practitioner.Qualification.Builder	Practitioner.Qualification.Builder.period(Period period)	Period during which the qualification is valid.
PractitionerRole.Builder	PractitionerRole.Builder.period(Period period)	The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
RelatedPerson.Builder	RelatedPerson.Builder.period(Period period)	The period of time during which this relationship is or was active.
ResearchStudy.Builder	ResearchStudy.Builder.period(Period period)	Identifies the start date and the expected (or actual, depending on status) end date for the study.
ResearchSubject.Builder	ResearchSubject.Builder.period(Period period)	The dates the subject began and ended their participation in the study.
Task.Restriction.Builder	Task.Restriction.Builder.period(Period period)	Over what time-period is fulfillment sought.
Schedule.Builder	Schedule.Builder.planningHorizon(Period planningHorizon)	The period of time that the slots that reference this Schedule resource cover (even if none exist).
ClaimResponse.Builder	ClaimResponse.Builder.preAuthPeriod(Period preAuthPeriod)	The time frame during which this authorization is effective.
ExplanationOfBenefit.Builder	ExplanationOfBenefit.Builder.preAuthRefPeriod(Period... preAuthRefPeriod)	The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided.
Appointment.Builder	Appointment.Builder.requestedPeriod(Period... requestedPeriod)	A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.
Account.Builder	Account.Builder.servicePeriod(Period servicePeriod)	The date range of services associated with this account.
Contract.Term.Asset.Builder	Contract.Term.Asset.Builder.usePeriod(Period... usePeriod)	Time period of asset use.
CatalogEntry.Builder	CatalogEntry.Builder.validityPeriod(Period validityPeriod)	The time period in which this catalog entry is expected to be active.
MedicationRequest.DispenseRequest.Builder	MedicationRequest.DispenseRequest.Builder.validityPeriod(Period validityPeriod)	This indicates the validity period of a prescription (stale dating the Prescription).
MedicinalProductAuthorization.Builder	MedicinalProductAuthorization.Builder.validityPeriod(Period validityPeriod)	The beginning of the time period in which the marketing authorization is in the specific status shall be specified A complete date consisting of day, month and year shall be specified using the ISO 8601 date format.
MedicinalProductAuthorization.JurisdictionalAuthorization.Builder	MedicinalProductAuthorization.JurisdictionalAuthorization.Builder.validityPeriod(Period validityPeriod)	The start and expected end date of the authorization.

Method parameters in com.ibm.fhir.model.resource with type arguments of type Period

Modifier and Type	Method	Description
Contract.Term.Asset.Builder	Contract.Term.Asset.Builder.period(Collection<Period> period)	Asset relevant contractual time period.
ExplanationOfBenefit.Builder	ExplanationOfBenefit.Builder.preAuthRefPeriod(Collection<Period> preAuthRefPeriod)	The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided.
Appointment.Builder	Appointment.Builder.requestedPeriod(Collection<Period> requestedPeriod)	A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.
Contract.Term.Asset.Builder	Contract.Term.Asset.Builder.usePeriod(Collection<Period> usePeriod)	Time period of asset use.

Uses of Period in com.ibm.fhir.model.type

Methods in com.ibm.fhir.model.type that return Period

Modifier and Type	Method	Description
Period	Period.Builder.build()	Build the Period
Period	MarketingStatus.getDateRange()	The date when the Medicinal Product is placed on the market by the Marketing Authorisation 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.
Period	Address.getPeriod()	Time period when address was/is in use.
Period	ContactPoint.getPeriod()	Time period when the contact point was/is in use.
Period	HumanName.getPeriod()	Indicates the period of time when this name was valid for the named person.
Period	Identifier.getPeriod()	Time period during which identifier is/was valid for use.

Methods in com.ibm.fhir.model.type with parameters of type Period

Modifier and Type	Method	Description
MarketingStatus.Builder	MarketingStatus.Builder.dateRange(Period dateRange)	The date when the Medicinal Product is placed on the market by the Marketing Authorisation 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.
protected Period.Builder	Period.Builder.from(Period period)
Address.Builder	Address.Builder.period(Period period)	Time period when address was/is in use.
ContactPoint.Builder	ContactPoint.Builder.period(Period period)	Time period when the contact point was/is in use.
HumanName.Builder	HumanName.Builder.period(Period period)	Indicates the period of time when this name was valid for the named person.
Identifier.Builder	Identifier.Builder.period(Period period)	Time period during which identifier is/was valid for use.

Uses of Period in com.ibm.fhir.model.visitor

Methods in com.ibm.fhir.model.visitor with parameters of type Period

Modifier and Type	Method	Description
boolean	DefaultVisitor.visit(String elementName, int elementIndex, Period period)	Delegates to #visit(elementName, elementIndex, Element)
boolean	Visitor.visit(String elementName, int elementIndex, Period period)