Protocol (HAPI FHIR Structures - DSTU2.1 (2016May) 3.3.0 API)

java.lang.Object
- org.hl7.fhir.dstu2016may.model.Base
- - org.hl7.fhir.dstu2016may.model.BaseResource
  - - org.hl7.fhir.dstu2016may.model.Resource
    - - org.hl7.fhir.dstu2016may.model.DomainResource
      - org.hl7.fhir.dstu2016may.model.Protocol

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
```
public class Protocol
extends DomainResource
```
A definition of behaviors to be taken in particular circumstances, often including conditions, options and other decision points.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Protocol.ActivityDefinitionCategory`
`static class`	`Protocol.ActivityDefinitionCategoryEnumFactory`
`static class`	`Protocol.ProtocolStatus`
`static class`	`Protocol.ProtocolStatusEnumFactory`
`static class`	`Protocol.ProtocolStepActivityComponent`
`static class`	`Protocol.ProtocolStepActivityComponentComponent`
`static class`	`Protocol.ProtocolStepActivityDetailComponent`
`static class`	`Protocol.ProtocolStepComponent`
`static class`	`Protocol.ProtocolStepNextComponent`
`static class`	`Protocol.ProtocolStepPreconditionComponent`
`static class`	`Protocol.ProtocolStepPreconditionConditionComponent`
`static class`	`Protocol.ProtocolType`
`static class`	`Protocol.ProtocolTypeEnumFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Reference`	`author` Who wrote protocol?
`protected Organization`	`authorTarget` The actual object that is the target of the reference (Who wrote protocol?)
`protected Reference`	`group` To whom does Protocol apply?
`protected Group`	`groupTarget` The actual object that is the target of the reference (To whom does Protocol apply?)
`protected List<Identifier>`	`identifier` A unique identifier for the protocol instance.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_SUBJECT` Constant for fluent queries to be used to add include statements.
`protected StringType`	`purpose` When is protocol to be used?
`static String`	`SP_IDENTIFIER` Search parameter: identifier
`static String`	`SP_SUBJECT` Search parameter: subject
`protected Enumeration<Protocol.ProtocolStatus>`	`status` The status of the protocol.
`protected List<Protocol.ProtocolStepComponent>`	`step` What's done as part of protocol.
`protected Reference`	`subject` What does protocol deal with?
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject
`protected Resource`	`subjectTarget` The actual object that is the target of the reference (What does protocol deal with?)
`protected StringType`	`title` Name of protocol.
`protected Enumeration<Protocol.ProtocolType>`	`type` A code that classifies the general type of context to which these behavior definitions apply.

Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu2016may.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
`Protocol()` Constructor
`Protocol(Enumeration<Protocol.ProtocolStatus> status, Enumeration<Protocol.ProtocolType> type, StringType purpose)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`Identifier`	`addIdentifier()`
`Protocol`	`addIdentifier(Identifier t)`
`Protocol.ProtocolStepComponent`	`addStep()`
`Protocol`	`addStep(Protocol.ProtocolStepComponent t)`
`Protocol`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`Reference`	`getAuthor()`
`Organization`	`getAuthorTarget()`
`Reference`	`getGroup()`
`Group`	`getGroupTarget()`
`List<Identifier>`	`getIdentifier()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`String`	`getPurpose()`
`StringType`	`getPurposeElement()`
`ResourceType`	`getResourceType()`
`Protocol.ProtocolStatus`	`getStatus()`
`Enumeration<Protocol.ProtocolStatus>`	`getStatusElement()`
`List<Protocol.ProtocolStepComponent>`	`getStep()`
`Reference`	`getSubject()`
`Resource`	`getSubjectTarget()`
`String`	`getTitle()`
`StringType`	`getTitleElement()`
`Protocol.ProtocolType`	`getType()`
`Enumeration<Protocol.ProtocolType>`	`getTypeElement()`
`boolean`	`hasAuthor()`
`boolean`	`hasGroup()`
`boolean`	`hasIdentifier()`
`boolean`	`hasPurpose()`
`boolean`	`hasPurposeElement()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasStep()`
`boolean`	`hasSubject()`
`boolean`	`hasTitle()`
`boolean`	`hasTitleElement()`
`boolean`	`hasType()`
`boolean`	`hasTypeElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`Protocol`	`setAuthor(Reference value)`
`Protocol`	`setAuthorTarget(Organization value)`
`Protocol`	`setGroup(Reference value)`
`Protocol`	`setGroupTarget(Group value)`
`void`	`setProperty(int hash, String name, Base value)`
`void`	`setProperty(String name, Base value)`
`Protocol`	`setPurpose(String value)`
`Protocol`	`setPurposeElement(StringType value)`
`Protocol`	`setStatus(Protocol.ProtocolStatus value)`
`Protocol`	`setStatusElement(Enumeration<Protocol.ProtocolStatus> value)`
`Protocol`	`setSubject(Reference value)`
`Protocol`	`setSubjectTarget(Resource value)`
`Protocol`	`setTitle(String value)`
`Protocol`	`setTitleElement(StringType value)`
`Protocol`	`setType(Protocol.ProtocolType value)`
`Protocol`	`setTypeElement(Enumeration<Protocol.ProtocolType> value)`
`protected Protocol`	`typedCopy()`

Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.dstu2016may.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource
getStructureFhirVersionEnum, setId

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, 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
  - identifier
```
protected List<Identifier> identifier
```
    A unique identifier for the protocol instance.
  - title
```
protected StringType title
```
    Name of protocol.
  - status
```
protected Enumeration<Protocol.ProtocolStatus> status
```
    The status of the protocol.
  - type
```
protected Enumeration<Protocol.ProtocolType> type
```
    A code that classifies the general type of context to which these behavior definitions apply. This is used for searching, sorting and display purposes.
  - subject
```
protected Reference subject
```
    What does protocol deal with?
  - subjectTarget
```
protected Resource subjectTarget
```
    The actual object that is the target of the reference (What does protocol deal with?)
  - group
```
protected Reference group
```
    To whom does Protocol apply?
  - groupTarget
```
protected Group groupTarget
```
    The actual object that is the target of the reference (To whom does Protocol apply?)
  - purpose
```
protected StringType purpose
```
    When is protocol to be used?
  - author
```
protected Reference author
```
    Who wrote protocol?
  - authorTarget
```
protected Organization authorTarget
```
    The actual object that is the target of the reference (Who wrote protocol?)
  - step
```
protected List<Protocol.ProtocolStepComponent> step
```
    What's done as part of protocol.
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    Search parameter: subject
    Description: Protocols with specified subject
    Type: reference
    Path: Protocol.subject
    
    See Also:
    
    Constant Field Values
  - SUBJECT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
```
    Fluent Client search parameter constant for subject
    Description: Protocols with specified subject
    Type: reference
    Path: Protocol.subject
  - INCLUDE_SUBJECT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Protocol:subject".
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter: identifier
    Description: The unique id for a particular protocol
    Type: token
    Path: Protocol.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: The unique id for a particular protocol
    Type: token
    Path: Protocol.identifier
- Constructor Detail
  - Protocol
```
public Protocol()
```
    Constructor
  - Protocol
```
public Protocol(Enumeration<Protocol.ProtocolStatus> status,
                Enumeration<Protocol.ProtocolType> type,
                StringType purpose)
```
    Constructor
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (A unique identifier for the protocol instance.)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
    Returns:
    
    identifier (A unique identifier for the protocol instance.)
  - addIdentifier
```
public Protocol addIdentifier(Identifier t)
```
  - getTitleElement
```
public StringType getTitleElement()
```
    Returns:
    
    title (Name of protocol.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
  - hasTitleElement
```
public boolean hasTitleElement()
```
  - hasTitle
```
public boolean hasTitle()
```
  - setTitleElement
```
public Protocol setTitleElement(StringType value)
```
    Parameters:
    
    value - title (Name of protocol.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
  - getTitle
```
public String getTitle()
```
    Returns:
    
    Name of protocol.
  - setTitle
```
public Protocol setTitle(String value)
```
    Parameters:
    
    value - Name of protocol.
  - getStatusElement
```
public Enumeration<Protocol.ProtocolStatus> getStatusElement()
```
    Returns:
    
    status (The status of the protocol.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - hasStatusElement
```
public boolean hasStatusElement()
```
  - hasStatus
```
public boolean hasStatus()
```
  - setStatusElement
```
public Protocol setStatusElement(Enumeration<Protocol.ProtocolStatus> value)
```
    Parameters:
    
    value - status (The status of the protocol.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - getStatus
```
public Protocol.ProtocolStatus getStatus()
```
    Returns:
    
    The status of the protocol.
  - setStatus
```
public Protocol setStatus(Protocol.ProtocolStatus value)
```
    Parameters:
    
    value - The status of the protocol.
  - getTypeElement
```
public Enumeration<Protocol.ProtocolType> getTypeElement()
```
    Returns:
    
    type (A code that classifies the general type of context to which these behavior definitions apply. This is used for searching, sorting and display purposes.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value
  - hasTypeElement
```
public boolean hasTypeElement()
```
  - hasType
```
public boolean hasType()
```
  - setTypeElement
```
public Protocol setTypeElement(Enumeration<Protocol.ProtocolType> value)
```
    Parameters:
    
    value - type (A code that classifies the general type of context to which these behavior definitions apply. This is used for searching, sorting and display purposes.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value
  - getType
```
public Protocol.ProtocolType getType()
```
    Returns:
    
    A code that classifies the general type of context to which these behavior definitions apply. This is used for searching, sorting and display purposes.
  - setType
```
public Protocol setType(Protocol.ProtocolType value)
```
    Parameters:
    
    value - A code that classifies the general type of context to which these behavior definitions apply. This is used for searching, sorting and display purposes.
  - getSubject
```
public Reference getSubject()
```
    Returns:
    
    subject (What does protocol deal with?)
  - hasSubject
```
public boolean hasSubject()
```
  - setSubject
```
public Protocol setSubject(Reference value)
```
    Parameters:
    
    value - subject (What does protocol deal with?)
  - getSubjectTarget
```
public Resource getSubjectTarget()
```
    Returns:
    
    subject The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (What does protocol deal with?)
  - setSubjectTarget
```
public Protocol setSubjectTarget(Resource value)
```
    Parameters:
    
    value - subject The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (What does protocol deal with?)
  - getGroup
```
public Reference getGroup()
```
    Returns:
    
    group (To whom does Protocol apply?)
  - hasGroup
```
public boolean hasGroup()
```
  - setGroup
```
public Protocol setGroup(Reference value)
```
    Parameters:
    
    value - group (To whom does Protocol apply?)
  - getGroupTarget
```
public Group getGroupTarget()
```
    Returns:
    
    group The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (To whom does Protocol apply?)
  - setGroupTarget
```
public Protocol setGroupTarget(Group value)
```
    Parameters:
    
    value - group The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (To whom does Protocol apply?)
  - getPurposeElement
```
public StringType getPurposeElement()
```
    Returns:
    
    purpose (When is protocol to be used?). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
  - hasPurposeElement
```
public boolean hasPurposeElement()
```
  - hasPurpose
```
public boolean hasPurpose()
```
  - setPurposeElement
```
public Protocol setPurposeElement(StringType value)
```
    Parameters:
    
    value - purpose (When is protocol to be used?). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
  - getPurpose
```
public String getPurpose()
```
    Returns:
    
    When is protocol to be used?
  - setPurpose
```
public Protocol setPurpose(String value)
```
    Parameters:
    
    value - When is protocol to be used?
  - getAuthor
```
public Reference getAuthor()
```
    Returns:
    
    author (Who wrote protocol?)
  - hasAuthor
```
public boolean hasAuthor()
```
  - setAuthor
```
public Protocol setAuthor(Reference value)
```
    Parameters:
    
    value - author (Who wrote protocol?)
  - getAuthorTarget
```
public Organization getAuthorTarget()
```
    Returns:
    
    author The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Who wrote protocol?)
  - setAuthorTarget
```
public Protocol setAuthorTarget(Organization value)
```
    Parameters:
    
    value - author The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Who wrote protocol?)
  - getStep
```
public List<Protocol.ProtocolStepComponent> getStep()
```
    Returns:
    
    step (What's done as part of protocol.)
  - hasStep
```
public boolean hasStep()
```
  - addStep
```
public Protocol.ProtocolStepComponent addStep()
```
    Returns:
    
    step (What's done as part of protocol.)
  - addStep
```
public Protocol addStep(Protocol.ProtocolStepComponent t)
```
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class DomainResource
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public void setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public Protocol copy()
```
    Specified by:
    
    copy in class DomainResource
  - typedCopy
```
protected Protocol typedCopy()
```
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class Protocol

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

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

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

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

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

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

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

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

Methods inherited from class java.lang.Object

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

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

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

Field Detail

identifier

title

status

type

subject

subjectTarget

group

groupTarget

purpose

author

authorTarget

step

SP_SUBJECT

SUBJECT

INCLUDE_SUBJECT

SP_IDENTIFIER

IDENTIFIER

Constructor Detail

Protocol

Protocol

Method Detail

getIdentifier

hasIdentifier

addIdentifier

addIdentifier

getTitleElement

hasTitleElement

hasTitle

setTitleElement

getTitle

setTitle

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus

getTypeElement

hasTypeElement

hasType

setTypeElement

getType

setType

getSubject

hasSubject

setSubject

getSubjectTarget

setSubjectTarget

getGroup

hasGroup

setGroup

getGroupTarget

setGroupTarget

getPurposeElement

hasPurposeElement

hasPurpose

setPurposeElement

getPurpose

setPurpose

getAuthor

hasAuthor

setAuthor