java.lang.Object
- org.hl7.fhir.r4.profilemodel.PEDefinition

Direct Known Subclasses:

PEDefinitionElement, PEDefinitionExtension, PEDefinitionResource, PEDefinitionSlice, PEDefinitionSubExtension, PEDefinitionTypeSlice
```
public abstract class PEDefinition
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class PEDefinition.PEDefinitionElementMode

Field Summary

Fields
Modifier and Type	Field	Description
`protected PEBuilder`	`builder`
`protected Map<String,List<PEDefinition>>`	`children`
`protected ElementDefinition`	`definition`
`protected String`	`name`
`protected String`	`path`
`protected StructureDefinition`	`profile`
`protected List<PEType>`	`types`

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`PEDefinition(PEBuilder builder, String name, StructureDefinition profile, ElementDefinition definition, String ppath)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`ElementDefinition`	`baseDefinition()`
`List<PEDefinition>`	`children()`
`List<PEDefinition>`	`children(boolean allFixed)`
`List<PEDefinition>`	`children(String typeUrl)`
`List<PEDefinition>`	`children(String typeUrl, boolean allFixed)`
`ElementDefinition`	`definition()`
`List<PEDefinition>`	`directChildren(boolean allFixed)`
`String`	`documentation()`
`abstract String`	`fhirpath()`	This is public to support unit testing - there's no reason to use it otherwise
`Type`	`getFixedValue()`
`StructureDefinition`	`getProfile()`
`List<PEDefinition>`	`getSlices()`
`boolean`	`hasFixedValue()`
`boolean`	`isBaseList()`
`boolean`	`isBasePrimitive()`
`boolean`	`isExtension()`
`boolean`	`isInFixedValue()`
`boolean`	`isKeyElement()`
`boolean`	`isList()`
`protected boolean`	`isMustHaveValue()`
`boolean`	`isPrimitive()`
`boolean`	`isProfiled()`
`boolean`	`isRecursing()`
`boolean`	`isSlicer()`
`protected abstract void`	`listTypes(List<PEType> types)`
`protected abstract void`	`makeChildren(String typeUrl, List<PEDefinition> children, boolean allFixed)`
`int`	`max()`
`int`	`min()`
`PEDefinition.PEDefinitionElementMode`	`mode()`
`String`	`name()`
`String`	`path()`
`boolean`	`repeats()`
`String`	`schemaName()`
`String`	`schemaNameWithType()`
`protected void`	`setInFixedValue(boolean inFixedValue)`
`protected void`	`setMustHaveValue(boolean mustHaveValue)`
`protected void`	`setRecursing(boolean recursing)`
`void`	`setSlicer(boolean isSlicer)`
`void`	`setSlices(List<PEDefinition> slices)`
`String`	`shortDocumentation()`
`String`	`toString()`
`List<PEType>`	`types()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - builder
```
protected PEBuilder builder
```
  - name
```
protected String name
```
  - path
```
protected String path
```
  - profile
```
protected StructureDefinition profile
```
  - definition
```
protected ElementDefinition definition
```
  - types
```
protected List<PEType> types
```
  - children
```
protected Map<String,List<PEDefinition>> children
```
- Constructor Detail
  - PEDefinition
```
protected PEDefinition(PEBuilder builder,
                       String name,
                       StructureDefinition profile,
                       ElementDefinition definition,
                       String ppath)
```
- Method Detail
  - name
```
public String name()
```
    Returns:
    
    The name of the element or slice in the profile (always unique amongst children)
  - path
```
public String path()
```
    Returns:
    
    The path of the element or slice in the profile (name.name.name...)
  - schemaName
```
public String schemaName()
```
    Returns:
    
    The name of the element in the resource (may be different to the slice name)
  - schemaNameWithType
```
public String schemaNameWithType()
```
    Returns:
    
    The name of the element in the resource (may be different to the slice name)
  - types
```
public List<PEType> types()
```
    Returns:
    
    a list of types. There is usually at least one type; it might be Element, Type, BackboneElement or BackboneType The following elements don't have types (true primitives): Element.id. Extension.url, PrimitiveType.value
  - listTypes
```
protected abstract void listTypes(List<PEType> types)
```
  - min
```
public int min()
```
    Returns:
    
    The minimum number of repeats allowed
  - max
```
public int max()
```
    Returns:
    
    the maximum number of repeats allowed
  - definition
```
public ElementDefinition definition()
```
    Returns:
    
    the definition of the element in the profile (fully populated) Note that the profile definition might be the same as a base definition, when the tree runs off the end of what's profiled
  - baseDefinition
```
public ElementDefinition baseDefinition()
```
    Returns:
    
    the definition of the element in the base specification Note that the profile definition might be the same as a base definition, when the tree runs off the end of what's profiled
  - shortDocumentation
```
public String shortDocumentation()
```
    Returns:
    
    the short documentation of the definition (shown in the profile table view)
  - documentation
```
public String documentation()
```
    Returns:
    
    the full definition of the element (markdown syntax)
  - children
```
public List<PEDefinition> children(String typeUrl)
```
    Parameters:
    
    typeUrl - - the url of one of the types listed in types()
    
    Returns:
    
    - the list of children for the nominated type Warning: profiles and resources can be recursive; you can't iterate this tree until you get to the leaves because you will never get to a child that doesn't have children (extensions have extensions etc)
  - children
```
public List<PEDefinition> children(String typeUrl,
                                   boolean allFixed)
```
  - children
```
public List<PEDefinition> children()
```
  - children
```
public List<PEDefinition> children(boolean allFixed)
```
  - hasFixedValue
```
public boolean hasFixedValue()
```
    Returns:
    
    True if the element has a fixed value. This will always be false if fixedProps = false when the builder is created
  - getFixedValue
```
public Type getFixedValue()
```
  - makeChildren
```
protected abstract void makeChildren(String typeUrl,
                                     List<PEDefinition> children,
                                     boolean allFixed)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isRecursing
```
public boolean isRecursing()
```
    Returns:
    
    true if the builder observes that this element is recursing (extensions have extensions) Note that this is unreliable and may be withdrawn if it can't be fixed
  - setRecursing
```
protected void setRecursing(boolean recursing)
```
  - isMustHaveValue
```
protected boolean isMustHaveValue()
```
  - setMustHaveValue
```
protected void setMustHaveValue(boolean mustHaveValue)
```
  - isInFixedValue
```
public boolean isInFixedValue()
```
    Returns:
    
    true if this property is inside an element that has an assigned fixed value
  - setInFixedValue
```
protected void setInFixedValue(boolean inFixedValue)
```
  - fhirpath
```
public abstract String fhirpath()
```
    This is public to support unit testing - there's no reason to use it otherwise
    
    Returns:
    
    used in the instance processor to differentiate slices
  - isList
```
public boolean isList()
```
  - repeats
```
public boolean repeats()
```
  - mode
```
public PEDefinition.PEDefinitionElementMode mode()
```
  - isProfiled
```
public boolean isProfiled()
```
    Returns:
    
    true if this element is profiled one way or another
  - isSlicer
```
public boolean isSlicer()
```
  - setSlicer
```
public void setSlicer(boolean isSlicer)
```
  - isBaseList
```
public boolean isBaseList()
```
  - getProfile
```
public StructureDefinition getProfile()
```
  - isKeyElement
```
public boolean isKeyElement()
```
  - isPrimitive
```
public boolean isPrimitive()
```
  - isBasePrimitive
```
public boolean isBasePrimitive()
```
  - directChildren
```
public List<PEDefinition> directChildren(boolean allFixed)
```
  - getSlices
```
public List<PEDefinition> getSlices()
```
  - setSlices
```
public void setSlices(List<PEDefinition> slices)
```
  - isExtension
```
public boolean isExtension()
```

Class PEDefinition

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

builder

name

path

profile

definition

types

children

Constructor Detail

PEDefinition

Method Detail

name

path

schemaName

schemaNameWithType

types

listTypes

min

max

definition

baseDefinition

shortDocumentation

documentation

children

children

children

children

hasFixedValue

getFixedValue

makeChildren

toString

isRecursing

setRecursing

isMustHaveValue

setMustHaveValue

isInFixedValue

setInFixedValue

fhirpath

isList

repeats

mode

isProfiled

isSlicer

setSlicer

isBaseList

getProfile

isKeyElement

isPrimitive

isBasePrimitive

directChildren

getSlices

setSlices

isExtension