
Package org.hl7.fhir.dstu3.model
Class MetadataResource
- java.lang.Object
-
- org.hl7.fhir.dstu3.model.Base
-
- org.hl7.fhir.dstu3.model.BaseResource
-
- org.hl7.fhir.dstu3.model.Resource
-
- org.hl7.fhir.dstu3.model.DomainResource
-
- org.hl7.fhir.dstu3.model.MetadataResource
-
- 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
- Direct Known Subclasses:
ActivityDefinition
,CapabilityStatement
,CodeSystem
,CompartmentDefinition
,ConceptMap
,DataElement
,ExpansionProfile
,GraphDefinition
,ImplementationGuide
,Library
,Measure
,MessageDefinition
,NamingSystem
,OperationDefinition
,PlanDefinition
,Questionnaire
,SearchParameter
,ServiceDefinition
,StructureDefinition
,StructureMap
,TestScript
,ValueSet
public abstract class MetadataResource extends DomainResource
Common Ancestor declaration for conformance and knowledge artifact resources.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected List<ContactDetail>
contact
Contact details to assist a user in finding and communicating with the publisher.protected DateTimeType
date
The date (and optionally time) when the metadata resource was published.protected MarkdownType
description
A free text natural language description of the metadata resource from a consumer's perspective.protected BooleanType
experimental
A boolean value to indicate that this metadata resource is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.protected List<CodeableConcept>
jurisdiction
A legal or geographic region in which the metadata resource is intended to be used.protected StringType
name
A natural language name identifying the metadata resource.protected StringType
publisher
The name of the individual or organization that published the metadata resource.protected Enumeration<Enumerations.PublicationStatus>
status
The status of this metadata resource.protected StringType
title
A short, descriptive, user-friendly title for the metadata resource.protected UriType
url
An absolute URI that is used to identify this metadata resource when it is referenced in a specification, model, design or an instance.protected List<UsageContext>
useContext
The content was developed with a focus and intent of supporting the contexts that are listed.protected StringType
version
The identifier that is used to identify this version of the metadata resource when it is referenced in a specification, model, design or instance.-
Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description MetadataResource()
ConstructorMetadataResource(Enumeration<Enumerations.PublicationStatus> status)
Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, getResourceType, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
url
protected UriType url
An absolute URI that is used to identify this metadata resource when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this metadata resource is (or will be) published. The URL SHOULD include the major version of the metadata resource. For more information see [Technical and Business Versions](resource.html#versions).
-
version
protected StringType version
The identifier that is used to identify this version of the metadata resource when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the metadata resource author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name
protected StringType name
A natural language name identifying the metadata resource. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title
protected StringType title
A short, descriptive, user-friendly title for the metadata resource.
-
status
protected Enumeration<Enumerations.PublicationStatus> status
The status of this metadata resource. Enables tracking the life-cycle of the content.
-
experimental
protected BooleanType experimental
A boolean value to indicate that this metadata resource is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date
protected DateTimeType date
The date (and optionally time) when the metadata resource was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the metadata resource changes.
-
publisher
protected StringType publisher
The name of the individual or organization that published the metadata resource.
-
contact
protected List<ContactDetail> contact
Contact details to assist a user in finding and communicating with the publisher.
-
useContext
protected List<UsageContext> useContext
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate metadata resource instances.
-
jurisdiction
protected List<CodeableConcept> jurisdiction
A legal or geographic region in which the metadata resource is intended to be used.
-
description
protected MarkdownType description
A free text natural language description of the metadata resource from a consumer's perspective.
-
-
Constructor Detail
-
MetadataResource
public MetadataResource()
Constructor
-
MetadataResource
public MetadataResource(Enumeration<Enumerations.PublicationStatus> status)
Constructor
-
-
Method Detail
-
getUrlElement
public UriType getUrlElement()
- Returns:
url
(An absolute URI that is used to identify this metadata resource when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this metadata resource is (or will be) published. The URL SHOULD include the major version of the metadata resource. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
hasUrlElement
public boolean hasUrlElement()
-
hasUrl
public boolean hasUrl()
-
setUrlElement
public MetadataResource setUrlElement(UriType value)
- Parameters:
value
-url
(An absolute URI that is used to identify this metadata resource when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this metadata resource is (or will be) published. The URL SHOULD include the major version of the metadata resource. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
checkCanUseUrl
protected void checkCanUseUrl()
-
getUrl
public String getUrl()
- Returns:
- An absolute URI that is used to identify this metadata resource when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this metadata resource is (or will be) published. The URL SHOULD include the major version of the metadata resource. For more information see [Technical and Business Versions](resource.html#versions).
-
setUrl
public MetadataResource setUrl(String value)
- Parameters:
value
- An absolute URI that is used to identify this metadata resource when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this metadata resource is (or will be) published. The URL SHOULD include the major version of the metadata resource. For more information see [Technical and Business Versions](resource.html#versions).
-
getVersionElement
public StringType getVersionElement()
- Returns:
version
(The identifier that is used to identify this version of the metadata resource when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the metadata resource author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
hasVersionElement
public boolean hasVersionElement()
-
hasVersion
public boolean hasVersion()
-
setVersionElement
public MetadataResource setVersionElement(StringType value)
- Parameters:
value
-version
(The identifier that is used to identify this version of the metadata resource when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the metadata resource author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
getVersion
public String getVersion()
- Returns:
- The identifier that is used to identify this version of the metadata resource when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the metadata resource author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
setVersion
public MetadataResource setVersion(String value)
- Parameters:
value
- The identifier that is used to identify this version of the metadata resource when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the metadata resource author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
getNameElement
public StringType getNameElement()
- Returns:
name
(A natural language name identifying the metadata resource. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
hasNameElement
public boolean hasNameElement()
-
hasName
public boolean hasName()
-
setNameElement
public MetadataResource setNameElement(StringType value)
- Parameters:
value
-name
(A natural language name identifying the metadata resource. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
getName
public String getName()
- Returns:
- A natural language name identifying the metadata resource. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
setName
public MetadataResource setName(String value)
- Parameters:
value
- A natural language name identifying the metadata resource. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
getTitleElement
public StringType getTitleElement()
- Returns:
title
(A short, descriptive, user-friendly title for the metadata resource.). 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 MetadataResource setTitleElement(StringType value)
- Parameters:
value
-title
(A short, descriptive, user-friendly title for the metadata resource.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
getTitle
public String getTitle()
- Returns:
- A short, descriptive, user-friendly title for the metadata resource.
-
setTitle
public MetadataResource setTitle(String value)
- Parameters:
value
- A short, descriptive, user-friendly title for the metadata resource.
-
getStatusElement
public Enumeration<Enumerations.PublicationStatus> getStatusElement()
- Returns:
status
(The status of this metadata resource. Enables tracking the life-cycle of the content.). 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 MetadataResource setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
- Parameters:
value
-status
(The status of this metadata resource. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public Enumerations.PublicationStatus getStatus()
- Returns:
- The status of this metadata resource. Enables tracking the life-cycle of the content.
-
setStatus
public MetadataResource setStatus(Enumerations.PublicationStatus value)
- Parameters:
value
- The status of this metadata resource. Enables tracking the life-cycle of the content.
-
getExperimentalElement
public BooleanType getExperimentalElement()
- Returns:
experimental
(A boolean value to indicate that this metadata resource is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
-
hasExperimentalElement
public boolean hasExperimentalElement()
-
hasExperimental
public boolean hasExperimental()
-
setExperimentalElement
public MetadataResource setExperimentalElement(BooleanType value)
- Parameters:
value
-experimental
(A boolean value to indicate that this metadata resource is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
-
getExperimental
public boolean getExperimental()
- Returns:
- A boolean value to indicate that this metadata resource is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
setExperimental
public MetadataResource setExperimental(boolean value)
- Parameters:
value
- A boolean value to indicate that this metadata resource is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
getDateElement
public DateTimeType getDateElement()
- Returns:
date
(The date (and optionally time) when the metadata resource was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the metadata resource changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
hasDateElement
public boolean hasDateElement()
-
hasDate
public boolean hasDate()
-
setDateElement
public MetadataResource setDateElement(DateTimeType value)
- Parameters:
value
-date
(The date (and optionally time) when the metadata resource was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the metadata resource changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
getDate
public Date getDate()
- Returns:
- The date (and optionally time) when the metadata resource was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the metadata resource changes.
-
setDate
public MetadataResource setDate(Date value)
- Parameters:
value
- The date (and optionally time) when the metadata resource was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the metadata resource changes.
-
getPublisherElement
public StringType getPublisherElement()
- Returns:
publisher
(The name of the individual or organization that published the metadata resource.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
hasPublisherElement
public boolean hasPublisherElement()
-
hasPublisher
public boolean hasPublisher()
-
setPublisherElement
public MetadataResource setPublisherElement(StringType value)
- Parameters:
value
-publisher
(The name of the individual or organization that published the metadata resource.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
getPublisher
public String getPublisher()
- Returns:
- The name of the individual or organization that published the metadata resource.
-
setPublisher
public MetadataResource setPublisher(String value)
- Parameters:
value
- The name of the individual or organization that published the metadata resource.
-
getContact
public List<ContactDetail> getContact()
- Returns:
contact
(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
public MetadataResource setContact(List<ContactDetail> theContact)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContact
public boolean hasContact()
-
addContact
public ContactDetail addContact()
-
addContact
public MetadataResource addContact(ContactDetail t)
-
getContactFirstRep
public ContactDetail getContactFirstRep()
- Returns:
- The first repetition of repeating field
contact
, creating it if it does not already exist
-
getUseContext
public List<UsageContext> getUseContext()
- Returns:
useContext
(The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate metadata resource instances.)
-
setUseContext
public MetadataResource setUseContext(List<UsageContext> theUseContext)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasUseContext
public boolean hasUseContext()
-
addUseContext
public UsageContext addUseContext()
-
addUseContext
public MetadataResource addUseContext(UsageContext t)
-
getUseContextFirstRep
public UsageContext getUseContextFirstRep()
- Returns:
- The first repetition of repeating field
useContext
, creating it if it does not already exist
-
getJurisdiction
public List<CodeableConcept> getJurisdiction()
- Returns:
jurisdiction
(A legal or geographic region in which the metadata resource is intended to be used.)
-
setJurisdiction
public MetadataResource setJurisdiction(List<CodeableConcept> theJurisdiction)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasJurisdiction
public boolean hasJurisdiction()
-
addJurisdiction
public CodeableConcept addJurisdiction()
-
addJurisdiction
public MetadataResource addJurisdiction(CodeableConcept t)
-
getJurisdictionFirstRep
public CodeableConcept getJurisdictionFirstRep()
- Returns:
- The first repetition of repeating field
jurisdiction
, creating it if it does not already exist
-
getDescriptionElement
public MarkdownType getDescriptionElement()
- Returns:
description
(A free text natural language description of the metadata resource from a consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
hasDescriptionElement
public boolean hasDescriptionElement()
-
hasDescription
public boolean hasDescription()
-
setDescriptionElement
public MetadataResource setDescriptionElement(MarkdownType value)
- Parameters:
value
-description
(A free text natural language description of the metadata resource from a consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
public String getDescription()
- Returns:
- A free text natural language description of the metadata resource from a consumer's perspective.
-
setDescription
public MetadataResource setDescription(String value)
- Parameters:
value
- A free text natural language description of the metadata resource from a consumer's perspective.
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedProperty
in classDomainResource
- 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 classDomainResource
- 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 classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
public abstract MetadataResource copy()
- Specified by:
copy
in classDomainResource
-
copyValues
public void copyValues(MetadataResource dst)
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
-