Package org.hl7.fhir.r5.openehr

Class PATHABLE

java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.LogicalBase
org.hl7.fhir.r5.openehr.Any
org.hl7.fhir.r5.openehr.PATHABLE
All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.ICompositeType
Direct Known Subclasses:
INSTRUCTION_DETAILS, ISM_TRANSITION, LOCATABLE
public abstract class PATHABLE extends Any implements org.hl7.fhir.instance.model.api.ICompositeType
The PATHABLE class defines the pathing capabilities used by nearly all classes in the openEHR reference model, mostly via inheritance of PATHABLE. The defining characteristics of PATHABLE objects are that they can locate child objects using paths, and they know their parent object in a compositional hierarchy. The parent feature is defined as abstract in the model, and may be implemented in any way convenient.
See Also:

  • Field Details

    • name

      protected DV_TEXT name
      This is the term provided via a clinical application or batch process to name this EHR construct: its retention in the EHR faithfully preserves the original label by which this entry was known to end users.

    • archetype_node_id

      protected StringType archetype_node_id
      Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. Always in the form of an at-code, e.g. at0005. This value enables a 'standardised' name for this node to be generated, by referring to the generating archetype local terminology.

    • uid

      protected UID_BASED_ID uid
      Optional globally unique object identifier for root points of archetyped structures.

    • archetype_details

      protected ARCHETYPED archetype_details
      Details of archetyping used on this node.

    • feeder_audit

      protected FEEDER_AUDIT feeder_audit
      Audit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node.

  • Constructor Details

  • Method Details

    • getName

      public DV_TEXT getName()
      Returns:
      name (This is the term provided via a clinical application or batch process to name this EHR construct: its retention in the EHR faithfully preserves the original label by which this entry was known to end users.)

    • hasName

      public boolean hasName()

    • setName

      public PATHABLE setName(DV_TEXT value)
      Parameters:
      value - name (This is the term provided via a clinical application or batch process to name this EHR construct: its retention in the EHR faithfully preserves the original label by which this entry was known to end users.)

    • getArchetype_node_idElement

      public StringType getArchetype_node_idElement()
      Returns:
      archetype_node_id (Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. Always in the form of an at-code, e.g. at0005. This value enables a 'standardised' name for this node to be generated, by referring to the generating archetype local terminology.). This is the underlying object with id, value and extensions. The accessor "getArchetype_node_id" gives direct access to the value

    • hasArchetype_node_idElement

      public boolean hasArchetype_node_idElement()

    • hasArchetype_node_id

      public boolean hasArchetype_node_id()

    • setArchetype_node_idElement

      public PATHABLE setArchetype_node_idElement(StringType value)
      Parameters:
      value - archetype_node_id (Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. Always in the form of an at-code, e.g. at0005. This value enables a 'standardised' name for this node to be generated, by referring to the generating archetype local terminology.). This is the underlying object with id, value and extensions. The accessor "getArchetype_node_id" gives direct access to the value

    • getArchetype_node_id

      public String getArchetype_node_id()
      Returns:
      Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. Always in the form of an at-code, e.g. at0005. This value enables a 'standardised' name for this node to be generated, by referring to the generating archetype local terminology.

    • setArchetype_node_id

      public PATHABLE setArchetype_node_id(String value)
      Parameters:
      value - Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. Always in the form of an at-code, e.g. at0005. This value enables a 'standardised' name for this node to be generated, by referring to the generating archetype local terminology.

    • getUid

      public UID_BASED_ID getUid()
      Returns:
      uid (Optional globally unique object identifier for root points of archetyped structures.)

    • hasUid

      public boolean hasUid()

    • setUid

      public PATHABLE setUid(UID_BASED_ID value)
      Parameters:
      value - uid (Optional globally unique object identifier for root points of archetyped structures.)

    • getLinksList

      public List<LINK> getLinksList()
      Returns:
      invalid reference 
      #links
      (Links to other archetyped structures (data whose root object inherits from ARCHETYPED, such as ENTRY, SECTION and so on). Links may be to structures in other compositions.)

    • setLinksList

      public PATHABLE setLinksList(List<LINK> theLinks)
      Returns:
      Returns a reference to this for easy method chaining

    • hasLinks

      public boolean hasLinks()

    • addLinks

      public LINK addLinks()

    • addLinks

      public PATHABLE addLinks(LINK t)

    • getLinksFirstRep

      public LINK getLinksFirstRep()
      Returns:
      The first repetition of repeating field
      invalid reference 
      #links
      , creating it if it does not already exist {3}

    • getArchetype_details

      public ARCHETYPED getArchetype_details()
      Returns:
      archetype_details (Details of archetyping used on this node.)

    • hasArchetype_details

      public boolean hasArchetype_details()

    • setArchetype_details

      public PATHABLE setArchetype_details(ARCHETYPED value)
      Parameters:
      value - archetype_details (Details of archetyping used on this node.)

    • getFeeder_audit

      public FEEDER_AUDIT getFeeder_audit()
      Returns:
      feeder_audit (Audit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node.)

    • hasFeeder_audit

      public boolean hasFeeder_audit()

    • setFeeder_audit

      public PATHABLE setFeeder_audit(FEEDER_AUDIT value)
      Parameters:
      value - feeder_audit (Audit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node.)

    • listChildren

      protected void listChildren(List<Property> children)
      Overrides:
      listChildren in class Base

    • getNamedProperty

      public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class Base
      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 Base
      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 Base
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class Base
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • makeProperty

      public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class Base
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getTypesForProperty

      public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty in class Base
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addChild

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

    • copy

      public abstract PATHABLE copy()
      Specified by:
      copy in class Any

    • copyValues

      public void copyValues(PATHABLE dst)

    • equalsDeep

      public boolean equalsDeep(Base other_)
      Overrides:
      equalsDeep in class Base

    • equalsShallow

      public boolean equalsShallow(Base other_)
      Overrides:
      equalsShallow in class Base

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      isEmpty in class Base