org.hl7.fhir.r4.model

Class DomainResource

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.BaseResource

org.hl7.fhir.r4.model.Resource

org.hl7.fhir.r4.model.DomainResource

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

Direct Known Subclasses:

Account, AdverseEvent, AllergyIntolerance, Appointment, AppointmentResponse, AuditEvent, Basic, BiologicallyDerivedProduct, BodyStructure, CarePlan, CareTeam, CatalogEntry, ChargeItem, Claim, ClaimResponse, ClinicalImpression, Communication, CommunicationRequest, Composition, Condition, Consent, Contract, Coverage, CoverageEligibilityRequest, CoverageEligibilityResponse, DetectedIssue, Device, DeviceDefinition, DeviceMetric, DeviceRequest, DeviceUseStatement, DiagnosticReport, DocumentManifest, DocumentReference, Encounter, Endpoint, EnrollmentRequest, EnrollmentResponse, EpisodeOfCare, ExplanationOfBenefit, FamilyMemberHistory, Flag, Goal, Group, GuidanceResponse, HealthcareService, ImagingStudy, Immunization, ImmunizationEvaluation, ImmunizationRecommendation, InsurancePlan, Invoice, Linkage, ListResource, Location, MeasureReport, Media, Medication, MedicationAdministration, MedicationDispense, MedicationKnowledge, MedicationRequest, MedicationStatement, MedicinalProduct, MedicinalProductAuthorization, MedicinalProductContraindication, MedicinalProductIndication, MedicinalProductIngredient, MedicinalProductInteraction, MedicinalProductManufactured, MedicinalProductPackaged, MedicinalProductPharmaceutical, MedicinalProductUndesirableEffect, MessageHeader, MetadataResource, MolecularSequence, NutritionOrder, Observation, ObservationDefinition, OperationOutcome, Organization, OrganizationAffiliation, Patient, PaymentNotice, PaymentReconciliation, Person, Practitioner, PractitionerRole, Procedure, Provenance, QuestionnaireResponse, RelatedPerson, RequestGroup, ResearchStudy, ResearchSubject, RiskAssessment, Schedule, ServiceRequest, Slot, Specimen, SpecimenDefinition, Subscription, Substance, SubstanceNucleicAcid, SubstancePolymer, SubstanceProtein, SubstanceReferenceInformation, SubstanceSourceMaterial, SubstanceSpecification, SupplyDelivery, SupplyRequest, Task, TestReport, VerificationResult, VisionPrescription

public abstract class DomainResource
extends Resource
implements org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IDomainResource

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Resource>	contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
protected List<Extension>	extension May be used to represent additional information that is not part of the basic definition of the resource.
protected 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.
protected 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.

Fields inherited from class org.hl7.fhir.r4.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor and Description
DomainResource() Constructor

Method Summary

Modifier and Type	Method and Description
Base	addChild(String name)
DomainResource	addContained(Resource t)
Extension	addExtension()
DomainResource	addExtension(Extension t)
void	addExtension(String url, Type value)
Extension	addModifierExtension()
DomainResource	addModifierExtension(Extension t)
void	checkNoModifiers(String noun, String verb)
abstract DomainResource	copy()
void	copyValues(DomainResource dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<Resource>	getContained()
List<Extension>	getExtension()
Extension	getExtensionByUrl(String theUrl)
List<Extension>	getExtensionsByUrl(String theUrl) Returns a list of extensions from this element which have the given URL.
List<Extension>	getModifierExtension()
List<Extension>	getModifierExtensionsByUrl(String theUrl) Returns a list of modifier extensions from this element which have the given URL.
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
Narrative	getText()
String[]	getTypesForProperty(int hash, String name)
boolean	hasContained()
boolean	hasExtension()
boolean	hasExtension(String url)
boolean	hasModifierExtension()
boolean	hasText()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
DomainResource	setContained(List<Resource> theContained)
DomainResource	setExtension(List<Extension> theExtension)
DomainResource	setModifierExtension(List<Extension> theModifierExtension)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
DomainResource	setText(Narrative value)

Methods inherited from class org.hl7.fhir.r4.model.Resource

copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getResourceType, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.r4.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r4.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Field Detail

text

protected 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.

contained

protected List<Resource> contained

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

extension

protected List<Extension> extension

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

modifierExtension

protected List<Extension> modifierExtension

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

Constructor Detail

DomainResource

public DomainResource()

Constructor

Method Detail

getText

public Narrative getText()

Specified by:

getText in interface org.hl7.fhir.instance.model.api.IDomainResource

Returns:

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.)

hasText

public boolean hasText()

setText

public DomainResource setText(Narrative value)

Parameters:

value - 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.)

getContained

public List<Resource> getContained()

Specified by:

getContained in interface org.hl7.fhir.instance.model.api.IDomainResource

Returns:

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

setContained

public DomainResource setContained(List<Resource> theContained)

Returns:

Returns a reference to this for easy method chaining

hasContained

public boolean hasContained()

addContained

public DomainResource addContained(Resource t)

getExtension

public List<Extension> getExtension()

Specified by:

getExtension in interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

Returns:

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

setExtension

public DomainResource setExtension(List<Extension> theExtension)

Returns:

Returns a reference to this for easy method chaining

hasExtension

public boolean hasExtension()

Specified by:

hasExtension in interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

addExtension

public Extension addExtension()

Specified by:

addExtension in interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

addExtension

public DomainResource addExtension(Extension t)

getModifierExtension

public List<Extension> getModifierExtension()

Specified by:

getModifierExtension in interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Returns:

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

setModifierExtension

public DomainResource setModifierExtension(List<Extension> theModifierExtension)

Returns:

Returns a reference to this for easy method chaining

hasModifierExtension

public boolean hasModifierExtension()

Specified by:

hasModifierExtension in interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

addModifierExtension

public Extension addModifierExtension()

Specified by:

addModifierExtension in interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

addModifierExtension

public DomainResource addModifierExtension(Extension t)

getExtensionsByUrl

public List<Extension> getExtensionsByUrl(String theUrl)

Returns a list of extensions from this element which have the given URL. Note that this list may not be modified (you can not add or remove elements from it)

getModifierExtensionsByUrl

public List<Extension> getModifierExtensionsByUrl(String theUrl)

Returns a list of modifier extensions from this element which have the given URL. Note that this list may not be modified (you can not add or remove elements from it)

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class Resource

getNamedProperty

public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class Resource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class Resource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class Resource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class Resource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class Resource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class Resource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class Resource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class Resource

copy

public abstract DomainResource copy()

Specified by:

copy in class Resource

copyValues

public void copyValues(DomainResource dst)

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class Resource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class Resource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class Resource

checkNoModifiers

public void checkNoModifiers(String noun,
                             String verb)
                      throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

addExtension

public void addExtension(String url,
                         Type value)

hasExtension

public boolean hasExtension(String url)

getExtensionByUrl

public Extension getExtensionByUrl(String theUrl)