Package org.hl7.fhir.r4.model

Class DomainResource

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

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

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

      • 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

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

      • 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

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

      • 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

      • 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

      • 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