Class RegulatedAuthorization
- 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
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base
Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason
-
Field Summary
Modifier and TypeFieldDescriptionAdditional information or supporting documentation about the authorization.protected List
<CodeableConcept> The legal or regulatory framework against which this authorization is granted, or other reasons for it.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for caseThe case or regulatory procedure for granting or amending a regulated authorization.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for case-typeprotected MarkdownType
General textual supporting information.protected Reference
The organization that has been granted this authorization, by some authoritative body (the 'regulator').static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for holderprotected List
<Identifier> Business identifier for the authorization, typically assigned by the authorizing body.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected List
<CodeableReference> Condition for which the use of the regulated product applies.protected CodeableConcept
The intended use of the product, e.g.protected List
<CodeableConcept> The territory (e.g., country, jurisdiction etc.) in which the authorization has been granted.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for regionprotected Reference
The regulatory authority or authorizing body granting the authorization.static final String
Search parameter: casestatic final String
Search parameter: case-typestatic final String
Search parameter: holderstatic final String
Search parameter: identifierstatic final String
Search parameter: regionstatic final String
Search parameter: statusstatic final String
Search parameter: subjectprotected CodeableConcept
The status that is authorised e.g.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusprotected DateTimeType
The date at which the current status was assigned.The product type, treatment, facility or activity that is being authorized.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for subjectprotected CodeableConcept
Overall type of this authorization, for example drug marketing approval, orphan drug designation.protected Period
The time period in which the regulatory approval, clearance or licencing is in effect.Fields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
Fields inherited from class org.hl7.fhir.r5.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
-
Method Summary
Modifier and TypeMethodDescriptionaddBasis()
copy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getBasis()
getCase()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) getType()
String[]
getTypesForProperty
(int hash, String name) boolean
boolean
hasBasis()
boolean
hasCase()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasType()
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setAttachedDocument
(List<Reference> theAttachedDocument) setBasis
(List<CodeableConcept> theBasis) setDescription
(String value) setIdentifier
(List<Identifier> theIdentifier) setIndication
(List<CodeableReference> theIndication) setIntendedUse
(CodeableConcept value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setRegion
(List<CodeableConcept> theRegion) setRegulator
(Reference value) setStatus
(CodeableConcept value) setStatusDate
(Date value) setStatusDateElement
(DateTimeType value) setSubject
(List<Reference> theSubject) setType
(CodeableConcept value) setValidityPeriod
(Period value) protected RegulatedAuthorization
Methods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setText
Methods inherited from class org.hl7.fhir.r5.model.Resource
copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath
Methods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r5.model.Base
addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, 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.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
Business identifier for the authorization, typically assigned by the authorizing body. -
subject
The product type, treatment, facility or activity that is being authorized. -
type
Overall type of this authorization, for example drug marketing approval, orphan drug designation. -
description
General textual supporting information. -
region
The territory (e.g., country, jurisdiction etc.) in which the authorization has been granted. -
status
The status that is authorised e.g. approved. Intermediate states and actions can be tracked with cases and applications. -
statusDate
The date at which the current status was assigned. -
validityPeriod
The time period in which the regulatory approval, clearance or licencing is in effect. As an example, a Marketing Authorization includes the date of authorization and/or an expiration date. -
indication
Condition for which the use of the regulated product applies. -
intendedUse
The intended use of the product, e.g. prevention, treatment, diagnosis. -
basis
The legal or regulatory framework against which this authorization is granted, or other reasons for it. -
holder
The organization that has been granted this authorization, by some authoritative body (the 'regulator'). -
regulator
The regulatory authority or authorizing body granting the authorization. For example, European Medicines Agency (EMA), Food and Drug Administration (FDA), Health Canada (HC), etc. -
attachedDocument
Additional information or supporting documentation about the authorization. -
case_
The case or regulatory procedure for granting or amending a regulated authorization. An authorization is granted in response to submissions/applications by those seeking authorization. A case is the administrative process that deals with the application(s) that relate to this and assesses them. Note: This area is subject to ongoing review and the workgroup is seeking implementer feedback on its use (see link at bottom of page). -
SP_CASE_TYPE
Search parameter: case-typeDescription: The defining type of case
Type: token
Path: RegulatedAuthorization.case.type
- See Also:
-
CASE_TYPE
Fluent Client search parameter constant for case-typeDescription: The defining type of case
Type: token
Path: RegulatedAuthorization.case.type
-
SP_CASE
Search parameter: caseDescription: The case or procedure number
Type: token
Path: RegulatedAuthorization.case.identifier
- See Also:
-
CASE
Fluent Client search parameter constant for caseDescription: The case or procedure number
Type: token
Path: RegulatedAuthorization.case.identifier
-
SP_HOLDER
Search parameter: holderDescription: The organization that holds the granted authorization
Type: reference
Path: RegulatedAuthorization.holder
- See Also:
-
HOLDER
Fluent Client search parameter constant for holderDescription: The organization that holds the granted authorization
Type: reference
Path: RegulatedAuthorization.holder
-
INCLUDE_HOLDER
Constant for fluent queries to be used to add include statements. Specifies the path value of "RegulatedAuthorization:holder". -
SP_IDENTIFIER
Search parameter: identifierDescription: Business identifier for the authorization, typically assigned by the authorizing body
Type: token
Path: RegulatedAuthorization.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Business identifier for the authorization, typically assigned by the authorizing body
Type: token
Path: RegulatedAuthorization.identifier
-
SP_REGION
Search parameter: regionDescription: The territory (e.g., country, jurisdiction etc.) in which the authorization has been granted
Type: token
Path: RegulatedAuthorization.region
- See Also:
-
REGION
Fluent Client search parameter constant for regionDescription: The territory (e.g., country, jurisdiction etc.) in which the authorization has been granted
Type: token
Path: RegulatedAuthorization.region
-
SP_STATUS
Search parameter: statusDescription: The status that is authorised e.g. approved. Intermediate states can be tracked with cases and applications
Type: token
Path: RegulatedAuthorization.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: The status that is authorised e.g. approved. Intermediate states can be tracked with cases and applications
Type: token
Path: RegulatedAuthorization.status
-
SP_SUBJECT
Search parameter: subjectDescription: The type of regulated product, treatment, facility or activity that is being authorized
Type: reference
Path: RegulatedAuthorization.subject
- See Also:
-
SUBJECT
Fluent Client search parameter constant for subjectDescription: The type of regulated product, treatment, facility or activity that is being authorized
Type: reference
Path: RegulatedAuthorization.subject
-
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "RegulatedAuthorization:subject".
-
-
Constructor Details
-
RegulatedAuthorization
public RegulatedAuthorization()Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Business identifier for the authorization, typically assigned by the authorizing body.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist {3}
-
getSubject
- Returns:
subject
(The product type, treatment, facility or activity that is being authorized.)
-
setSubject
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSubject
-
addSubject
-
addSubject
-
getSubjectFirstRep
- Returns:
- The first repetition of repeating field
subject
, creating it if it does not already exist {3}
-
getType
- Returns:
type
(Overall type of this authorization, for example drug marketing approval, orphan drug designation.)
-
hasType
-
setType
- Parameters:
value
-type
(Overall type of this authorization, for example drug marketing approval, orphan drug designation.)
-
getDescriptionElement
- Returns:
description
(General textual supporting information.). 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
(General textual supporting information.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
- Returns:
- General textual supporting information.
-
setDescription
- Parameters:
value
- General textual supporting information.
-
getRegion
- Returns:
region
(The territory (e.g., country, jurisdiction etc.) in which the authorization has been granted.)
-
setRegion
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasRegion
-
addRegion
-
addRegion
-
getRegionFirstRep
- Returns:
- The first repetition of repeating field
region
, creating it if it does not already exist {3}
-
getStatus
- Returns:
status
(The status that is authorised e.g. approved. Intermediate states and actions can be tracked with cases and applications.)
-
hasStatus
-
setStatus
- Parameters:
value
-status
(The status that is authorised e.g. approved. Intermediate states and actions can be tracked with cases and applications.)
-
getStatusDateElement
- Returns:
statusDate
(The date at which the current status was assigned.). This is the underlying object with id, value and extensions. The accessor "getStatusDate" gives direct access to the value
-
hasStatusDateElement
-
hasStatusDate
-
setStatusDateElement
- Parameters:
value
-statusDate
(The date at which the current status was assigned.). This is the underlying object with id, value and extensions. The accessor "getStatusDate" gives direct access to the value
-
getStatusDate
- Returns:
- The date at which the current status was assigned.
-
setStatusDate
- Parameters:
value
- The date at which the current status was assigned.
-
getValidityPeriod
- Returns:
validityPeriod
(The time period in which the regulatory approval, clearance or licencing is in effect. As an example, a Marketing Authorization includes the date of authorization and/or an expiration date.)
-
hasValidityPeriod
-
setValidityPeriod
- Parameters:
value
-validityPeriod
(The time period in which the regulatory approval, clearance or licencing is in effect. As an example, a Marketing Authorization includes the date of authorization and/or an expiration date.)
-
getIndication
- Returns:
indication
(Condition for which the use of the regulated product applies.)
-
setIndication
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIndication
-
addIndication
-
addIndication
-
getIndicationFirstRep
- Returns:
- The first repetition of repeating field
indication
, creating it if it does not already exist {3}
-
getIntendedUse
- Returns:
intendedUse
(The intended use of the product, e.g. prevention, treatment, diagnosis.)
-
hasIntendedUse
-
setIntendedUse
- Parameters:
value
-intendedUse
(The intended use of the product, e.g. prevention, treatment, diagnosis.)
-
getBasis
- Returns:
basis
(The legal or regulatory framework against which this authorization is granted, or other reasons for it.)
-
setBasis
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasBasis
-
addBasis
-
addBasis
-
getBasisFirstRep
- Returns:
- The first repetition of repeating field
basis
, creating it if it does not already exist {3}
-
getHolder
- Returns:
holder
(The organization that has been granted this authorization, by some authoritative body (the 'regulator').)
-
hasHolder
-
setHolder
- Parameters:
value
-holder
(The organization that has been granted this authorization, by some authoritative body (the 'regulator').)
-
getRegulator
- Returns:
regulator
(The regulatory authority or authorizing body granting the authorization. For example, European Medicines Agency (EMA), Food and Drug Administration (FDA), Health Canada (HC), etc.)
-
hasRegulator
-
setRegulator
- Parameters:
value
-regulator
(The regulatory authority or authorizing body granting the authorization. For example, European Medicines Agency (EMA), Food and Drug Administration (FDA), Health Canada (HC), etc.)
-
getAttachedDocument
- Returns:
attachedDocument
(Additional information or supporting documentation about the authorization.)
-
setAttachedDocument
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAttachedDocument
-
addAttachedDocument
-
addAttachedDocument
-
getAttachedDocumentFirstRep
- Returns:
- The first repetition of repeating field
attachedDocument
, creating it if it does not already exist {3}
-
getCase
- Returns:
case_
(The case or regulatory procedure for granting or amending a regulated authorization. An authorization is granted in response to submissions/applications by those seeking authorization. A case is the administrative process that deals with the application(s) that relate to this and assesses them. Note: This area is subject to ongoing review and the workgroup is seeking implementer feedback on its use (see link at bottom of page).)
-
hasCase
-
setCase
public RegulatedAuthorization setCase(RegulatedAuthorization.RegulatedAuthorizationCaseComponent value) - Parameters:
value
-case_
(The case or regulatory procedure for granting or amending a regulated authorization. An authorization is granted in response to submissions/applications by those seeking authorization. A case is the administrative process that deals with the application(s) that relate to this and assesses them. Note: This area is subject to ongoing review and the workgroup is seeking implementer feedback on its use (see link at bottom of page).)
-
listChildren
- 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
- 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
- Returns:
- the FHIR type name of the instance (not the java class name)
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
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
-
getResourceType
- Specified by:
getResourceType
in classResource
-