Package org.hl7.fhir.r5.model

Class DomainResource

java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.BaseResource
org.hl7.fhir.r5.model.Resource
org.hl7.fhir.r5.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, AdministrableProductDefinition, AdverseEvent, AllergyIntolerance, Appointment, AppointmentResponse, ArtifactAssessment, AuditEvent, Basic, BiologicallyDerivedProduct, BiologicallyDerivedProductDispense, BodyStructure, CanonicalResource, CarePlan, CareTeam, ChargeItem, Claim, ClaimResponse, ClinicalImpression, ClinicalUseDefinition, Communication, CommunicationRequest, Composition, Condition, Consent, Contract, Coverage, CoverageEligibilityRequest, CoverageEligibilityResponse, DetectedIssue, Device, DeviceAssociation, DeviceDefinition, DeviceDispense, DeviceMetric, DeviceRequest, DeviceUsage, DiagnosticReport, DocumentReference, Encounter, EncounterHistory, Endpoint, EnrollmentRequest, EnrollmentResponse, EpisodeOfCare, ExplanationOfBenefit, FamilyMemberHistory, Flag, FormularyItem, GenomicStudy, Goal, Group, GuidanceResponse, HealthcareService, ImagingSelection, ImagingStudy, Immunization, ImmunizationEvaluation, ImmunizationRecommendation, Ingredient, InsurancePlan, InventoryItem, InventoryReport, Invoice, Linkage, ListResource, Location, ManufacturedItemDefinition, MeasureReport, Medication, MedicationAdministration, MedicationDispense, MedicationKnowledge, MedicationRequest, MedicationStatement, MedicinalProductDefinition, MessageHeader, MolecularSequence, NutritionIntake, NutritionOrder, NutritionProduct, Observation, ObservationDefinition, OperationOutcome, Organization, OrganizationAffiliation, PackagedProductDefinition, Patient, PaymentNotice, PaymentReconciliation, Permission, Person, Practitioner, PractitionerRole, Procedure, Provenance, QuestionnaireResponse, RegulatedAuthorization, RelatedPerson, RequestOrchestration, ResearchStudy, ResearchSubject, RiskAssessment, Schedule, ServiceRequest, Slot, Specimen, SpecimenDefinition, Subscription, SubscriptionStatus, Substance, SubstanceDefinition, SubstanceNucleicAcid, SubstancePolymer, SubstanceProtein, SubstanceReferenceInformation, SubstanceSourceMaterial, SupplyDelivery, SupplyRequest, Task, TestReport, Transport, 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:

  • Field Details

    • 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, 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

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

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

    • SP_TEXT

      public static final String SP_TEXT
      Search parameter: _text

      Description: Search on the narrative of the resource
      Type: special
      Path: null

      See Also:

    • TEXT

      public static final ca.uhn.fhir.rest.gclient.SpecialClientParam TEXT
      Fluent Client search parameter constant for _text

      Description: Search on the narrative of the resource
      Type: special
      Path: null

  • Constructor Details

  • Method Details

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

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

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

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

    • 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

    • removeChild

      public void removeChild(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      removeChild 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
      Returns:
      the FHIR type name of the instance (not the java class name)

    • 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, DataType value)

    • hasExtension

      public boolean hasExtension(String... theUrls)

    • hasExtension

      public boolean hasExtension(String url)

    • hasPrimitiveExtension

      public boolean hasPrimitiveExtension(String url)

    • getExtensionByUrl

      public Extension getExtensionByUrl(String theUrl)

    • getExtensionString

      public String getExtensionString(String theUrl) throws org.hl7.fhir.exceptions.FHIRException
      Returns the value as a string if this element has only one extension that matches the given URL, and that can be converted to a string.

      Note: BackboneElements override this to check Modifier Extensions too

      Parameters:
      theUrl - The URL. Must not be blank or null.
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getExtensionString

      public String getExtensionString(String... theUrls) throws org.hl7.fhir.exceptions.FHIRException
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getContained

      public Resource getContained(String ref)

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

    • getExtensionsByUrl

      public List<Extension> getExtensionsByUrl(String... theUrls)

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

    • getStandardsStatus

      public org.hl7.fhir.utilities.StandardsStatus getStandardsStatus()

    • setStandardsStatus

      public void setStandardsStatus(org.hl7.fhir.utilities.StandardsStatus status)