Package com.ibm.fhir.model.resource

Class DomainResource

java.lang.Object

com.ibm.fhir.model.visitor.AbstractVisitable

com.ibm.fhir.model.resource.Resource

com.ibm.fhir.model.resource.DomainResource

All Implemented Interfaces:

Visitable

Direct Known Subclasses:

Account, ActivityDefinition, AdverseEvent, AllergyIntolerance, Appointment, AppointmentResponse, AuditEvent, Basic, BiologicallyDerivedProduct, BodyStructure, CapabilityStatement, CarePlan, CareTeam, CatalogEntry, ChargeItem, ChargeItemDefinition, Claim, ClaimResponse, ClinicalImpression, CodeSystem, Communication, CommunicationRequest, CompartmentDefinition, Composition, ConceptMap, Condition, Consent, Contract, Coverage, CoverageEligibilityRequest, CoverageEligibilityResponse, DetectedIssue, Device, DeviceDefinition, DeviceMetric, DeviceRequest, DeviceUseStatement, DiagnosticReport, DocumentManifest, DocumentReference, EffectEvidenceSynthesis, Encounter, Endpoint, EnrollmentRequest, EnrollmentResponse, EpisodeOfCare, EventDefinition, Evidence, EvidenceVariable, ExampleScenario, ExplanationOfBenefit, FamilyMemberHistory, Flag, Goal, GraphDefinition, Group, GuidanceResponse, HealthcareService, ImagingStudy, Immunization, ImmunizationEvaluation, ImmunizationRecommendation, ImplementationGuide, InsurancePlan, Invoice, Library, Linkage, List, Location, Measure, MeasureReport, Media, Medication, MedicationAdministration, MedicationDispense, MedicationKnowledge, MedicationRequest, MedicationStatement, MedicinalProduct, MedicinalProductAuthorization, MedicinalProductContraindication, MedicinalProductIndication, MedicinalProductIngredient, MedicinalProductInteraction, MedicinalProductManufactured, MedicinalProductPackaged, MedicinalProductPharmaceutical, MedicinalProductUndesirableEffect, MessageDefinition, MessageHeader, MolecularSequence, NamingSystem, NutritionOrder, Observation, ObservationDefinition, OperationDefinition, OperationOutcome, Organization, OrganizationAffiliation, Patient, PaymentNotice, PaymentReconciliation, Person, PlanDefinition, Practitioner, PractitionerRole, Procedure, Provenance, Questionnaire, QuestionnaireResponse, RelatedPerson, RequestGroup, ResearchDefinition, ResearchElementDefinition, ResearchStudy, ResearchSubject, RiskAssessment, RiskEvidenceSynthesis, Schedule, SearchParameter, ServiceRequest, Slot, Specimen, SpecimenDefinition, StructureDefinition, StructureMap, Subscription, Substance, SubstanceNucleicAcid, SubstancePolymer, SubstanceProtein, SubstanceReferenceInformation, SubstanceSourceMaterial, SubstanceSpecification, SupplyDelivery, SupplyRequest, Task, TerminologyCapabilities, TestReport, TestScript, ValueSet, VerificationResult, VisionPrescription

@Generated("com.ibm.fhir.tools.CodeGenerator")
public abstract class DomainResource
extends Resource

A resource that includes narrative, extensions, and contained resources.

Maturity level: FMM5 (Normative)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DomainResource.Builder

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<Resource>	contained
protected java.util.List<Extension>	extension
protected java.util.List<Extension>	modifierExtension
protected Narrative	text

Fields inherited from class com.ibm.fhir.model.resource.Resource

hashCode, id, implicitRules, language, meta

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DomainResource(DomainResource.Builder builder)

Method Summary

Modifier and Type	Method	Description
java.util.List<Resource>	getContained()	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
java.util.List<Extension>	getExtension()	May be used to represent additional information that is not part of the basic definition of the resource.
java.util.List<Extension>	getModifierExtension()	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.
Narrative	getText()	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.
boolean	hasChildren()
abstract DomainResource.Builder	toBuilder()	Create a new Builder from the contents of this Resource

Methods inherited from class com.ibm.fhir.model.resource.Resource

as, getId, getImplicitRules, getLanguage, getMeta, is

Methods inherited from class com.ibm.fhir.model.visitor.AbstractVisitable

accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, toString

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.fhir.model.visitor.Visitable

accept, accept

Field Detail

text

protected final Narrative text

contained

protected final java.util.List<Resource> contained

extension

protected final java.util.List<Extension> extension

modifierExtension

protected final java.util.List<Extension> modifierExtension

Constructor Detail

DomainResource

protected DomainResource(DomainResource.Builder builder)

Method Detail

getText

public Narrative getText()

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.

Returns:

An immutable object of type Narrative that may be null.

getContained

public java.util.List<Resource> getContained()

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Returns:

An unmodifiable list containing immutable objects of type Resource that may be empty.

getExtension

public java.util.List<Extension> getExtension()

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Returns:

An unmodifiable list containing immutable objects of type Extension that may be empty.

getModifierExtension

public java.util.List<Extension> getModifierExtension()

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Returns:

An unmodifiable list containing immutable objects of type Extension that may be empty.

hasChildren

public boolean hasChildren()

Overrides:

hasChildren in class Resource

toBuilder

public abstract DomainResource.Builder toBuilder()

Description copied from class: Resource

Create a new Builder from the contents of this Resource

Specified by:

toBuilder in class Resource