public class Profile extends BaseResource implements IResource
Definition: A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions
Requirements:
Profile Definition: http://hl7.org/fhir/profiles/Profile
| Modifier and Type | Class and Description |
|---|---|
static class |
Profile.ExtensionDefn
Block class for child element: Profile.extensionDefn (Definition of an extension)
|
static class |
Profile.Mapping
Block class for child element: Profile.mapping (External specification that the content is mapped to)
|
static class |
Profile.Query
Block class for child element: Profile.query (Definition of a named query)
|
static class |
Profile.Structure
Block class for child element: Profile.structure (A constraint on a resource or a data type)
|
static class |
Profile.StructureElement
Block class for child element: Profile.structure.element (Definition of elements in the resource (if no profile))
|
static class |
Profile.StructureElementDefinition
Block class for child element: Profile.structure.element.definition (More specific definition of the element)
|
static class |
Profile.StructureElementDefinitionBinding
Block class for child element: Profile.structure.element.definition.binding (ValueSet details if this is coded)
|
static class |
Profile.StructureElementDefinitionConstraint
Block class for child element: Profile.structure.element.definition.constraint (Condition that must evaluate to true)
|
static class |
Profile.StructureElementDefinitionMapping
Block class for child element: Profile.structure.element.definition.mapping (Map element to another set of definitions)
|
static class |
Profile.StructureElementDefinitionType
Block class for child element: Profile.structure.element.definition.type (Data type and Profile for this element)
|
static class |
Profile.StructureElementSlicing
Block class for child element: Profile.structure.element.slicing (This element is sliced - slices follow)
|
static class |
Profile.StructureSearchParam
Block class for child element: Profile.structure.searchParam (Search params defined)
|
| Modifier and Type | Field and Description |
|---|---|
static TokenClientParam |
CODE
Fluent Client search parameter constant for code
|
static DateClientParam |
DATE
Fluent Client search parameter constant for date
|
static StringClientParam |
DESCRIPTION
Fluent Client search parameter constant for description
|
static TokenClientParam |
EXTENSION
Fluent Client search parameter constant for extension
|
static TokenClientParam |
IDENTIFIER
Fluent Client search parameter constant for identifier
|
static Include |
INCLUDE_STRUCTURE_ELEMENT_DEFINITION_BINDING_REFERENCE
Constant for fluent queries to be used to add include statements.
|
static StringClientParam |
NAME
Fluent Client search parameter constant for name
|
static StringClientParam |
PUBLISHER
Fluent Client search parameter constant for publisher
|
static String |
SP_CODE
Search parameter constant for code
|
static String |
SP_DATE
Search parameter constant for date
|
static String |
SP_DESCRIPTION
Search parameter constant for description
|
static String |
SP_EXTENSION
Search parameter constant for extension
|
static String |
SP_IDENTIFIER
Search parameter constant for identifier
|
static String |
SP_NAME
Search parameter constant for name
|
static String |
SP_PUBLISHER
Search parameter constant for publisher
|
static String |
SP_STATUS
Search parameter constant for status
|
static String |
SP_TYPE
Search parameter constant for type
|
static String |
SP_VALUESET
Search parameter constant for valueset
|
static String |
SP_VERSION
Search parameter constant for version
|
static TokenClientParam |
STATUS
Fluent Client search parameter constant for status
|
static TokenClientParam |
TYPE
Fluent Client search parameter constant for type
|
static ReferenceClientParam |
VALUESET
Fluent Client search parameter constant for valueset
|
static TokenClientParam |
VERSION
Fluent Client search parameter constant for version
|
SP_RES_ID, SP_RES_LANGUAGE| Constructor and Description |
|---|
Profile() |
| Modifier and Type | Method and Description |
|---|---|
CodingDt |
addCode()
Adds and returns a new value for code (Assist with indexing and finding)
|
Profile.ExtensionDefn |
addExtensionDefn()
Adds and returns a new value for extensionDefn (Definition of an extension)
|
Profile.Mapping |
addMapping()
Adds and returns a new value for mapping (External specification that the content is mapped to)
|
Profile.Query |
addQuery()
Adds and returns a new value for query (Definition of a named query)
|
Profile.Structure |
addStructure()
Adds and returns a new value for structure (A constraint on a resource or a data type)
|
ContactDt |
addTelecom()
Adds and returns a new value for telecom (Contact information of the publisher)
|
Profile |
addTelecom(ContactUseEnum theContactUse,
String theValue)
Adds a new value for telecom (Contact information of the publisher)
|
Profile |
addTelecom(String theValue)
Adds a new value for telecom (Contact information of the publisher)
|
<T extends IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType)
Returns a list containing all child elements matching a given type
|
List<CodingDt> |
getCode()
Gets the value(s) for code (Assist with indexing and finding).
|
CodingDt |
getCodeFirstRep()
Gets the first repetition for code (Assist with indexing and finding),
creating it if it does not already exist.
|
DateTimeDt |
getDate()
Gets the value(s) for date (Date for this version of the profile).
|
StringDt |
getDescription()
Gets the value(s) for description (Natural language description of the profile).
|
BooleanDt |
getExperimental()
Gets the value(s) for experimental (If for testing purposes, not real usage).
|
List<Profile.ExtensionDefn> |
getExtensionDefn()
Gets the value(s) for extensionDefn (Definition of an extension).
|
Profile.ExtensionDefn |
getExtensionDefnFirstRep()
Gets the first repetition for extensionDefn (Definition of an extension),
creating it if it does not already exist.
|
IdDt |
getFhirVersion()
Gets the value(s) for fhirVersion (FHIR Version this profile targets).
|
StringDt |
getIdentifier()
Gets the value(s) for identifier (Logical id to reference this profile).
|
List<Profile.Mapping> |
getMapping()
Gets the value(s) for mapping (External specification that the content is mapped to).
|
Profile.Mapping |
getMappingFirstRep()
Gets the first repetition for mapping (External specification that the content is mapped to),
creating it if it does not already exist.
|
StringDt |
getName()
Gets the value(s) for name (Informal name for this profile).
|
StringDt |
getPublisher()
Gets the value(s) for publisher (Name of the publisher (Organization or individual)).
|
List<Profile.Query> |
getQuery()
Gets the value(s) for query (Definition of a named query).
|
Profile.Query |
getQueryFirstRep()
Gets the first repetition for query (Definition of a named query),
creating it if it does not already exist.
|
StringDt |
getRequirements()
Gets the value(s) for requirements (Scope and Usage this profile is for).
|
BoundCodeDt<ResourceProfileStatusEnum> |
getStatus()
Gets the value(s) for status (draft | active | retired).
|
List<Profile.Structure> |
getStructure()
Gets the value(s) for structure (A constraint on a resource or a data type).
|
Profile.Structure |
getStructureFirstRep()
Gets the first repetition for structure (A constraint on a resource or a data type),
creating it if it does not already exist.
|
List<ContactDt> |
getTelecom()
Gets the value(s) for telecom (Contact information of the publisher).
|
ContactDt |
getTelecomFirstRep()
Gets the first repetition for telecom (Contact information of the publisher),
creating it if it does not already exist.
|
StringDt |
getVersion()
Gets the value(s) for version (Logical id for this version of the profile).
|
boolean |
isEmpty() |
Profile |
setCode(List<CodingDt> theValue)
Sets the value(s) for code (Assist with indexing and finding)
|
Profile |
setDate(Date theDate,
TemporalPrecisionEnum thePrecision)
Sets the value for date (Date for this version of the profile)
|
Profile |
setDate(DateTimeDt theValue)
Sets the value(s) for date (Date for this version of the profile)
|
Profile |
setDateWithSecondsPrecision(Date theDate)
Sets the value for date (Date for this version of the profile)
|
Profile |
setDescription(String theString)
Sets the value for description (Natural language description of the profile)
|
Profile |
setDescription(StringDt theValue)
Sets the value(s) for description (Natural language description of the profile)
|
Profile |
setExperimental(boolean theBoolean)
Sets the value for experimental (If for testing purposes, not real usage)
|
Profile |
setExperimental(BooleanDt theValue)
Sets the value(s) for experimental (If for testing purposes, not real usage)
|
Profile |
setExtensionDefn(List<Profile.ExtensionDefn> theValue)
Sets the value(s) for extensionDefn (Definition of an extension)
|
Profile |
setFhirVersion(IdDt theValue)
Sets the value(s) for fhirVersion (FHIR Version this profile targets)
|
Profile |
setFhirVersion(String theId)
Sets the value for fhirVersion (FHIR Version this profile targets)
|
Profile |
setIdentifier(String theString)
Sets the value for identifier (Logical id to reference this profile)
|
Profile |
setIdentifier(StringDt theValue)
Sets the value(s) for identifier (Logical id to reference this profile)
|
Profile |
setMapping(List<Profile.Mapping> theValue)
Sets the value(s) for mapping (External specification that the content is mapped to)
|
Profile |
setName(String theString)
Sets the value for name (Informal name for this profile)
|
Profile |
setName(StringDt theValue)
Sets the value(s) for name (Informal name for this profile)
|
Profile |
setPublisher(String theString)
Sets the value for publisher (Name of the publisher (Organization or individual))
|
Profile |
setPublisher(StringDt theValue)
Sets the value(s) for publisher (Name of the publisher (Organization or individual))
|
Profile |
setQuery(List<Profile.Query> theValue)
Sets the value(s) for query (Definition of a named query)
|
Profile |
setRequirements(String theString)
Sets the value for requirements (Scope and Usage this profile is for)
|
Profile |
setRequirements(StringDt theValue)
Sets the value(s) for requirements (Scope and Usage this profile is for)
|
Profile |
setStatus(BoundCodeDt<ResourceProfileStatusEnum> theValue)
Sets the value(s) for status (draft | active | retired)
|
Profile |
setStatus(ResourceProfileStatusEnum theValue)
Sets the value(s) for status (draft | active | retired)
|
Profile |
setStructure(List<Profile.Structure> theValue)
Sets the value(s) for structure (A constraint on a resource or a data type)
|
Profile |
setTelecom(List<ContactDt> theValue)
Sets the value(s) for telecom (Contact information of the publisher)
|
Profile |
setVersion(String theString)
Sets the value for version (Logical id for this version of the profile)
|
Profile |
setVersion(StringDt theValue)
Sets the value(s) for version (Logical id for this version of the profile)
|
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setLanguage, setResourceMetadata, setText, toStringaddUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensionsclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadatapublic static final String SP_IDENTIFIER
Description: The identifier of the profile
Type: token
Path: Profile.identifier
public static final TokenClientParam IDENTIFIER
Description: The identifier of the profile
Type: token
Path: Profile.identifier
public static final String SP_VERSION
Description: The version identifier of the profile
Type: token
Path: Profile.version
public static final TokenClientParam VERSION
Description: The version identifier of the profile
Type: token
Path: Profile.version
public static final String SP_NAME
Description: Name of the profile
Type: string
Path: Profile.name
public static final StringClientParam NAME
Description: Name of the profile
Type: string
Path: Profile.name
public static final String SP_PUBLISHER
Description: Name of the publisher of the profile
Type: string
Path: Profile.publisher
public static final StringClientParam PUBLISHER
Description: Name of the publisher of the profile
Type: string
Path: Profile.publisher
public static final String SP_DESCRIPTION
Description: Text search in the description of the profile
Type: string
Path: Profile.description
public static final StringClientParam DESCRIPTION
Description: Text search in the description of the profile
Type: string
Path: Profile.description
public static final String SP_STATUS
Description: The current status of the profile
Type: token
Path: Profile.status
public static final TokenClientParam STATUS
Description: The current status of the profile
Type: token
Path: Profile.status
public static final String SP_DATE
Description: The profile publication date
Type: date
Path: Profile.date
public static final DateClientParam DATE
Description: The profile publication date
Type: date
Path: Profile.date
public static final String SP_CODE
Description: A code for the profile in the format uri::code (server may choose to do subsumption)
Type: token
Path: Profile.code
public static final TokenClientParam CODE
Description: A code for the profile in the format uri::code (server may choose to do subsumption)
Type: token
Path: Profile.code
public static final String SP_EXTENSION
Description: An extension code (use or definition)
Type: token
Path: Profile.extensionDefn.code
public static final TokenClientParam EXTENSION
Description: An extension code (use or definition)
Type: token
Path: Profile.extensionDefn.code
public static final String SP_VALUESET
Description: A vocabulary binding code
Type: reference
Path: Profile.structure.element.definition.binding.reference[x]
public static final ReferenceClientParam VALUESET
Description: A vocabulary binding code
Type: reference
Path: Profile.structure.element.definition.binding.reference[x]
public static final Include INCLUDE_STRUCTURE_ELEMENT_DEFINITION_BINDING_REFERENCE
public static final String SP_TYPE
Description: Type of resource that is constrained in the profile
Type: token
Path: Profile.structure.type
public static final TokenClientParam TYPE
Description: Type of resource that is constrained in the profile
Type: token
Path: Profile.structure.type
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
ICompositeElementgetAllPopulatedChildElementsOfType in interface ICompositeElementtheType - The type to match. If set to null, all child elements will be returnedpublic StringDt getIdentifier()
null.
Definition: The identifier that is used to identify this profile when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI)
public Profile setIdentifier(StringDt theValue)
Definition: The identifier that is used to identify this profile when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI)
public Profile setIdentifier(String theString)
Definition: The identifier that is used to identify this profile when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI)
public StringDt getVersion()
null.
Definition: The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp
public Profile setVersion(StringDt theValue)
Definition: The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp
public Profile setVersion(String theString)
Definition: The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp
public StringDt getName()
null.
Definition: A free text natural language name identifying the Profile
public Profile setName(StringDt theValue)
Definition: A free text natural language name identifying the Profile
public Profile setName(String theString)
Definition: A free text natural language name identifying the Profile
public StringDt getPublisher()
null.
Definition: Details of the individual or organization who accepts responsibility for publishing the profile
public Profile setPublisher(StringDt theValue)
Definition: Details of the individual or organization who accepts responsibility for publishing the profile
public Profile setPublisher(String theString)
Definition: Details of the individual or organization who accepts responsibility for publishing the profile
public List<ContactDt> getTelecom()
null.
Definition: Contact details to assist a user in finding and communicating with the publisher
public Profile setTelecom(List<ContactDt> theValue)
Definition: Contact details to assist a user in finding and communicating with the publisher
public ContactDt addTelecom()
Definition: Contact details to assist a user in finding and communicating with the publisher
public ContactDt getTelecomFirstRep()
Definition: Contact details to assist a user in finding and communicating with the publisher
public Profile addTelecom(ContactUseEnum theContactUse, String theValue)
Definition: Contact details to assist a user in finding and communicating with the publisher
public Profile addTelecom(String theValue)
Definition: Contact details to assist a user in finding and communicating with the publisher
public StringDt getDescription()
null.
Definition: A free text natural language description of the profile and its use
public Profile setDescription(StringDt theValue)
Definition: A free text natural language description of the profile and its use
public Profile setDescription(String theString)
Definition: A free text natural language description of the profile and its use
public List<CodingDt> getCode()
null.
Definition: A set of terms from external terminologies that may be used to assist with indexing and searching of templates.
public Profile setCode(List<CodingDt> theValue)
Definition: A set of terms from external terminologies that may be used to assist with indexing and searching of templates.
public CodingDt addCode()
Definition: A set of terms from external terminologies that may be used to assist with indexing and searching of templates.
public CodingDt getCodeFirstRep()
Definition: A set of terms from external terminologies that may be used to assist with indexing and searching of templates.
public BoundCodeDt<ResourceProfileStatusEnum> getStatus()
null.
Definition: The status of the profile
public Profile setStatus(BoundCodeDt<ResourceProfileStatusEnum> theValue)
Definition: The status of the profile
public Profile setStatus(ResourceProfileStatusEnum theValue)
Definition: The status of the profile
public BooleanDt getExperimental()
null.
Definition: This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage
public Profile setExperimental(BooleanDt theValue)
Definition: This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage
public Profile setExperimental(boolean theBoolean)
Definition: This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage
public DateTimeDt getDate()
null.
Definition: The date that this version of the profile was published
public Profile setDate(DateTimeDt theValue)
Definition: The date that this version of the profile was published
public Profile setDateWithSecondsPrecision(Date theDate)
Definition: The date that this version of the profile was published
public Profile setDate(Date theDate, TemporalPrecisionEnum thePrecision)
Definition: The date that this version of the profile was published
public StringDt getRequirements()
null.
Definition: The Scope and Usage that this profile was created to meet
public Profile setRequirements(StringDt theValue)
Definition: The Scope and Usage that this profile was created to meet
public Profile setRequirements(String theString)
Definition: The Scope and Usage that this profile was created to meet
public IdDt getFhirVersion()
null.
Definition: The version of the FHIR specification on which this profile is based
public Profile setFhirVersion(IdDt theValue)
Definition: The version of the FHIR specification on which this profile is based
public Profile setFhirVersion(String theId)
Definition: The version of the FHIR specification on which this profile is based
public List<Profile.Mapping> getMapping()
null.
Definition: An external specification that the content is mapped to
public Profile setMapping(List<Profile.Mapping> theValue)
Definition: An external specification that the content is mapped to
public Profile.Mapping addMapping()
Definition: An external specification that the content is mapped to
public Profile.Mapping getMappingFirstRep()
Definition: An external specification that the content is mapped to
public List<Profile.Structure> getStructure()
null.
Definition: A constraint statement about what contents a resource or data type may have
public Profile setStructure(List<Profile.Structure> theValue)
Definition: A constraint statement about what contents a resource or data type may have
public Profile.Structure addStructure()
Definition: A constraint statement about what contents a resource or data type may have
public Profile.Structure getStructureFirstRep()
Definition: A constraint statement about what contents a resource or data type may have
public List<Profile.ExtensionDefn> getExtensionDefn()
null.
Definition: An extension defined as part of the profile
public Profile setExtensionDefn(List<Profile.ExtensionDefn> theValue)
Definition: An extension defined as part of the profile
public Profile.ExtensionDefn addExtensionDefn()
Definition: An extension defined as part of the profile
public Profile.ExtensionDefn getExtensionDefnFirstRep()
Definition: An extension defined as part of the profile
public List<Profile.Query> getQuery()
null.
Definition: Definition of a named query and its parameters and their meaning
public Profile setQuery(List<Profile.Query> theValue)
Definition: Definition of a named query and its parameters and their meaning
public Profile.Query addQuery()
Definition: Definition of a named query and its parameters and their meaning
public Profile.Query getQueryFirstRep()
Definition: Definition of a named query and its parameters and their meaning
Copyright © 2014 University Health Network. All rights reserved.