Package org.hl7.fhir.r4.model
Class MetadataResource
java.lang.Object
org.hl7.fhir.r4.model.Base
org.hl7.fhir.r4.model.BaseResource
org.hl7.fhir.r4.model.Resource
org.hl7.fhir.r4.model.DomainResource
org.hl7.fhir.r4.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
,ChargeItemDefinition
,CodeSystem
,CompartmentDefinition
,ConceptMap
,EffectEvidenceSynthesis
,EventDefinition
,Evidence
,EvidenceVariable
,ExampleScenario
,GraphDefinition
,ImplementationGuide
,Library
,Measure
,MessageDefinition
,NamingSystem
,OperationDefinition
,PlanDefinition
,Questionnaire
,ResearchDefinition
,ResearchElementDefinition
,RiskEvidenceSynthesis
,SearchParameter
,StructureDefinition
,StructureMap
,TerminologyCapabilities
,TestScript
,ValueSet
Common Ancestor declaration for conformance and knowledge artifact resources.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected List
<ContactDetail> Contact details to assist a user in finding and communicating with the publisher.protected DateTimeType
The date (and optionally time) when the metadata resource was published.protected MarkdownType
A free text natural language description of the metadata resource from a consumer's perspective.protected BooleanType
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> A legal or geographic region in which the metadata resource is intended to be used.protected StringType
A natural language name identifying the metadata resource.protected StringType
The name of the organization or individual that published the metadata resource.protected Enumeration
<Enumerations.PublicationStatus> The status of this metadata resource.protected StringType
A short, descriptive, user-friendly title for the metadata resource.protected UriType
An absolute URI that is used to identify this metadata resource when it is referenced in a specification, model, design or an instance; also called its canonical identifier.protected List
<UsageContext> The content was developed with a focus and intent of supporting the contexts that are listed.protected StringType
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.r4.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorDescriptionConstructorConstructor -
Method Summary
Modifier and TypeMethodDescriptionabstract MetadataResource
copy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getDate()
boolean
getName()
Base[]
getProperty
(int hash, String name, boolean checkValid) getTitle()
String[]
getTypesForProperty
(int hash, String name) getUrl()
boolean
boolean
hasDate()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasName()
boolean
boolean
boolean
boolean
boolean
boolean
hasTitle()
boolean
boolean
hasUrl()
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) present()
void
removeChild
(String name, Base value) setContact
(List<ContactDetail> theContact) setDateElement
(DateTimeType value) setDescription
(String value) setExperimental
(boolean value) setJurisdiction
(List<CodeableConcept> theJurisdiction) setNameElement
(StringType value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setPublisher
(String value) setPublisherElement
(StringType value) setTitleElement
(StringType value) setUrlElement
(UriType value) setUseContext
(List<UsageContext> theUseContext) setVersion
(String value) setVersionElement
(StringType value) toString()
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getNamedProperty, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, 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.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
url
An absolute URI that is used to identify this metadata resource when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this metadata resource is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the metadata resource is stored on different servers. -
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
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
A short, descriptive, user-friendly title for the metadata resource. -
status
The status of this metadata resource. Enables tracking the life-cycle of the content. -
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
The date (and optionally time) when the metadata resource was published. The date must change 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
The name of the organization or individual that published the metadata resource. -
contact
Contact details to assist a user in finding and communicating with the publisher. -
description
A free text natural language description of the metadata resource from a consumer's perspective. -
useContext
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate metadata resource instances. -
jurisdiction
A legal or geographic region in which the metadata resource is intended to be used.
-
-
Constructor Details
-
MetadataResource
public MetadataResource()Constructor -
MetadataResource
Constructor
-
-
Method Details
-
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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this metadata resource is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the metadata resource is stored on different servers.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
hasUrlElement
-
hasUrl
-
setUrlElement
- 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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this metadata resource is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the metadata resource is stored on different servers.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this metadata resource is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the metadata resource is stored on different servers.
-
setUrl
- 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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this metadata resource is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the metadata resource is stored on different servers.
-
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
-
hasVersion
-
setVersionElement
- 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
- 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
- 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
- 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
-
hasName
-
setNameElement
- 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
- 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
- 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
- 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
-
hasTitle
-
setTitleElement
- 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
- Returns:
- A short, descriptive, user-friendly title for the metadata resource.
-
setTitle
- Parameters:
value
- A short, descriptive, user-friendly title for the metadata resource.
-
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
-
hasStatus
-
setStatusElement
- 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
- Returns:
- The status of this metadata resource. Enables tracking the life-cycle of the content.
-
setStatus
- Parameters:
value
- The status of this metadata resource. Enables tracking the life-cycle of the content.
-
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
-
hasExperimental
-
setExperimentalElement
- 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
- 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
- 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
- Returns:
date
(The date (and optionally time) when the metadata resource was published. The date must change 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
-
hasDate
-
setDateElement
- Parameters:
value
-date
(The date (and optionally time) when the metadata resource was published. The date must change 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
- Returns:
- The date (and optionally time) when the metadata resource was published. The date must change 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
- Parameters:
value
- The date (and optionally time) when the metadata resource was published. The date must change 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
- Returns:
publisher
(The name of the organization or individual 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
-
hasPublisher
-
setPublisherElement
- Parameters:
value
-publisher
(The name of the organization or individual 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
- Returns:
- The name of the organization or individual that published the metadata resource.
-
setPublisher
- Parameters:
value
- The name of the organization or individual that published the metadata resource.
-
getContact
- Returns:
contact
(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContact
-
addContact
-
addContact
-
getContactFirstRep
- Returns:
- The first repetition of repeating field
contact
, creating it if it does not already exist
-
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
-
hasDescription
-
setDescriptionElement
- 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
- Returns:
- A free text natural language description of the metadata resource from a consumer's perspective.
-
setDescription
- Parameters:
value
- A free text natural language description of the metadata resource from a consumer's perspective.
-
getUseContext
- Returns:
useContext
(The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate metadata resource instances.)
-
setUseContext
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasUseContext
-
addUseContext
-
addUseContext
-
getUseContextFirstRep
- Returns:
- The first repetition of repeating field
useContext
, creating it if it does not already exist
-
getJurisdiction
- Returns:
jurisdiction
(A legal or geographic region in which the metadata resource is intended to be used.)
-
setJurisdiction
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasJurisdiction
-
addJurisdiction
-
addJurisdiction
-
getJurisdictionFirstRep
- Returns:
- The first repetition of repeating field
jurisdiction
, creating it if it does not already exist
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
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
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- 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
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
toString
-
present
-