Class RegulatedAuthorization
- java.lang.Object
-
- org.hl7.fhir.r5.model.Base
-
- org.hl7.fhir.r5.model.BaseResource
-
- org.hl7.fhir.r5.model.Resource
-
- org.hl7.fhir.r5.model.DomainResource
-
- org.hl7.fhir.r5.model.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
public class RegulatedAuthorization extends DomainResource
Regulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity that is cited in a guidance, regulation, rule or legislative act. An example is Market Authorization relating to a Medicinal Product.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classRegulatedAuthorization.RegulatedAuthorizationCaseComponent
-
Field Summary
Fields Modifier and Type Field Description protected List<Reference>attachedDocumentAdditional information or supporting documentation about the authorization.protected List<CodeableConcept>basisThe legal or regulatory framework against which this authorization is granted, or other reasons for it.static ca.uhn.fhir.rest.gclient.TokenClientParamCASEFluent Client search parameter constant for caseprotected RegulatedAuthorization.RegulatedAuthorizationCaseComponentcase_The case or regulatory procedure for granting or amending a marketing authorization.static ca.uhn.fhir.rest.gclient.TokenClientParamCASE_TYPEFluent Client search parameter constant for case-typeprotected MarkdownTypedescriptionGeneral textual supporting information.protected ReferenceholderThe organization that holds the granted authorization.static ca.uhn.fhir.rest.gclient.ReferenceClientParamHOLDERFluent Client search parameter constant for holderprotected List<Identifier>identifierBusiness identifier for the authorization, typically assigned by the authorizing body.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_HOLDERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SUBJECTConstant for fluent queries to be used to add include statements.protected CodeableReferenceindicationCondition for which the use of the regulated product applies.protected CodeableConceptintendedUseThe intended use of the product, e.g.protected List<CodeableConcept>regionThe territory (e.g., country, jurisdiction etc.) in which the authorization has been granted.static ca.uhn.fhir.rest.gclient.TokenClientParamREGIONFluent Client search parameter constant for regionprotected ReferenceregulatorThe regulatory authority or authorizing body granting the authorization.static StringSP_CASESearch parameter: casestatic StringSP_CASE_TYPESearch parameter: case-typestatic StringSP_HOLDERSearch parameter: holderstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_REGIONSearch parameter: regionstatic StringSP_STATUSSearch parameter: statusstatic StringSP_SUBJECTSearch parameter: subjectprotected CodeableConceptstatusThe status that is authorised e.g.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected DateTimeTypestatusDateThe date at which the current status was assigned.protected List<Reference>subjectThe product type, treatment, facility or activity that is being authorized.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUBJECTFluent Client search parameter constant for subjectprotected CodeableConcepttypeOverall type of this authorization, for example drug marketing approval, orphan drug designation.protected PeriodvalidityPeriodThe 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
-
-
Constructor Summary
Constructors Constructor Description RegulatedAuthorization()Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r5.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, 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, toString, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
Business identifier for the authorization, typically assigned by the authorizing body.
-
subject
protected List<Reference> subject
The product type, treatment, facility or activity that is being authorized.
-
type
protected CodeableConcept type
Overall type of this authorization, for example drug marketing approval, orphan drug designation.
-
description
protected MarkdownType description
General textual supporting information.
-
region
protected List<CodeableConcept> region
The territory (e.g., country, jurisdiction etc.) in which the authorization has been granted.
-
status
protected CodeableConcept status
The status that is authorised e.g. approved. Intermediate states can be tracked with cases and applications.
-
statusDate
protected DateTimeType statusDate
The date at which the current status was assigned.
-
validityPeriod
protected Period 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
protected CodeableReference indication
Condition for which the use of the regulated product applies.
-
intendedUse
protected CodeableConcept intendedUse
The intended use of the product, e.g. prevention, treatment.
-
basis
protected List<CodeableConcept> basis
The legal or regulatory framework against which this authorization is granted, or other reasons for it.
-
regulator
protected Reference 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
protected List<Reference> attachedDocument
Additional information or supporting documentation about the authorization.
-
case_
protected RegulatedAuthorization.RegulatedAuthorizationCaseComponent case_
The case or regulatory procedure for granting or amending a marketing authorization. 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
public static final String SP_CASE_TYPE
Search parameter: case-typeDescription: The defining type of case
Type: token
Path: RegulatedAuthorization.case.type
- See Also:
- Constant Field Values
-
CASE_TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CASE_TYPE
Fluent Client search parameter constant for case-typeDescription: The defining type of case
Type: token
Path: RegulatedAuthorization.case.type
-
SP_CASE
public static final String SP_CASE
Search parameter: caseDescription: The case or procedure number
Type: token
Path: RegulatedAuthorization.case.identifier
- See Also:
- Constant Field Values
-
CASE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CASE
Fluent Client search parameter constant for caseDescription: The case or procedure number
Type: token
Path: RegulatedAuthorization.case.identifier
-
SP_HOLDER
public static final String SP_HOLDER
Search parameter: holderDescription: The organization that holds the granted authorization
Type: reference
Path: RegulatedAuthorization.holder
- See Also:
- Constant Field Values
-
HOLDER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam HOLDER
Fluent Client search parameter constant for holderDescription: The organization that holds the granted authorization
Type: reference
Path: RegulatedAuthorization.holder
-
INCLUDE_HOLDER
public static final ca.uhn.fhir.model.api.Include INCLUDE_HOLDER
Constant for fluent queries to be used to add include statements. Specifies the path value of "RegulatedAuthorization:holder".
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Business identifier for the authorization, typically assigned by the authorizing body
Type: token
Path: RegulatedAuthorization.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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
public static final String 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:
- Constant Field Values
-
REGION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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
public static final String 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:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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
public static final String 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:
- Constant Field Values
-
SUBJECT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam 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
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "RegulatedAuthorization:subject".
-
-
Constructor Detail
-
RegulatedAuthorization
public RegulatedAuthorization()
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(Business identifier for the authorization, typically assigned by the authorizing body.)
-
setIdentifier
public RegulatedAuthorization setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public RegulatedAuthorization addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist {3}
-
getSubject
public List<Reference> getSubject()
- Returns:
subject(The product type, treatment, facility or activity that is being authorized.)
-
setSubject
public RegulatedAuthorization setSubject(List<Reference> theSubject)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSubject
public boolean hasSubject()
-
addSubject
public Reference addSubject()
-
addSubject
public RegulatedAuthorization addSubject(Reference t)
-
getSubjectFirstRep
public Reference getSubjectFirstRep()
- Returns:
- The first repetition of repeating field
subject, creating it if it does not already exist {3}
-
getType
public CodeableConcept getType()
- Returns:
type(Overall type of this authorization, for example drug marketing approval, orphan drug designation.)
-
hasType
public boolean hasType()
-
setType
public RegulatedAuthorization setType(CodeableConcept value)
- Parameters:
value-type(Overall type of this authorization, for example drug marketing approval, orphan drug designation.)
-
getDescriptionElement
public MarkdownType 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
public boolean hasDescriptionElement()
-
hasDescription
public boolean hasDescription()
-
setDescriptionElement
public RegulatedAuthorization setDescriptionElement(MarkdownType value)
- 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
public String getDescription()
- Returns:
- General textual supporting information.
-
setDescription
public RegulatedAuthorization setDescription(String value)
- Parameters:
value- General textual supporting information.
-
getRegion
public List<CodeableConcept> getRegion()
- Returns:
region(The territory (e.g., country, jurisdiction etc.) in which the authorization has been granted.)
-
setRegion
public RegulatedAuthorization setRegion(List<CodeableConcept> theRegion)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasRegion
public boolean hasRegion()
-
addRegion
public CodeableConcept addRegion()
-
addRegion
public RegulatedAuthorization addRegion(CodeableConcept t)
-
getRegionFirstRep
public CodeableConcept getRegionFirstRep()
- Returns:
- The first repetition of repeating field
region, creating it if it does not already exist {3}
-
getStatus
public CodeableConcept getStatus()
- Returns:
status(The status that is authorised e.g. approved. Intermediate states can be tracked with cases and applications.)
-
hasStatus
public boolean hasStatus()
-
setStatus
public RegulatedAuthorization setStatus(CodeableConcept value)
- Parameters:
value-status(The status that is authorised e.g. approved. Intermediate states can be tracked with cases and applications.)
-
getStatusDateElement
public DateTimeType 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
public boolean hasStatusDateElement()
-
hasStatusDate
public boolean hasStatusDate()
-
setStatusDateElement
public RegulatedAuthorization setStatusDateElement(DateTimeType value)
- 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
public Date getStatusDate()
- Returns:
- The date at which the current status was assigned.
-
setStatusDate
public RegulatedAuthorization setStatusDate(Date value)
- Parameters:
value- The date at which the current status was assigned.
-
getValidityPeriod
public Period 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
public boolean hasValidityPeriod()
-
setValidityPeriod
public RegulatedAuthorization setValidityPeriod(Period value)
- 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
public CodeableReference getIndication()
- Returns:
indication(Condition for which the use of the regulated product applies.)
-
hasIndication
public boolean hasIndication()
-
setIndication
public RegulatedAuthorization setIndication(CodeableReference value)
- Parameters:
value-indication(Condition for which the use of the regulated product applies.)
-
getIntendedUse
public CodeableConcept getIntendedUse()
- Returns:
intendedUse(The intended use of the product, e.g. prevention, treatment.)
-
hasIntendedUse
public boolean hasIntendedUse()
-
setIntendedUse
public RegulatedAuthorization setIntendedUse(CodeableConcept value)
- Parameters:
value-intendedUse(The intended use of the product, e.g. prevention, treatment.)
-
getBasis
public List<CodeableConcept> getBasis()
- Returns:
basis(The legal or regulatory framework against which this authorization is granted, or other reasons for it.)
-
setBasis
public RegulatedAuthorization setBasis(List<CodeableConcept> theBasis)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasBasis
public boolean hasBasis()
-
addBasis
public CodeableConcept addBasis()
-
addBasis
public RegulatedAuthorization addBasis(CodeableConcept t)
-
getBasisFirstRep
public CodeableConcept getBasisFirstRep()
- Returns:
- The first repetition of repeating field
basis, creating it if it does not already exist {3}
-
getHolder
public Reference getHolder()
- Returns:
holder(The organization that holds the granted authorization.)
-
hasHolder
public boolean hasHolder()
-
setHolder
public RegulatedAuthorization setHolder(Reference value)
- Parameters:
value-holder(The organization that holds the granted authorization.)
-
getRegulator
public Reference 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
public boolean hasRegulator()
-
setRegulator
public RegulatedAuthorization setRegulator(Reference value)
- 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
public List<Reference> getAttachedDocument()
- Returns:
attachedDocument(Additional information or supporting documentation about the authorization.)
-
setAttachedDocument
public RegulatedAuthorization setAttachedDocument(List<Reference> theAttachedDocument)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAttachedDocument
public boolean hasAttachedDocument()
-
addAttachedDocument
public Reference addAttachedDocument()
-
addAttachedDocument
public RegulatedAuthorization addAttachedDocument(Reference t)
-
getAttachedDocumentFirstRep
public Reference getAttachedDocumentFirstRep()
- Returns:
- The first repetition of repeating field
attachedDocument, creating it if it does not already exist {3}
-
getCase
public RegulatedAuthorization.RegulatedAuthorizationCaseComponent getCase()
- Returns:
case_(The case or regulatory procedure for granting or amending a marketing authorization. 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
public boolean hasCase()
-
setCase
public RegulatedAuthorization setCase(RegulatedAuthorization.RegulatedAuthorizationCaseComponent value)
- Parameters:
value-case_(The case or regulatory procedure for granting or amending a marketing authorization. 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
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public RegulatedAuthorization copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(RegulatedAuthorization dst)
-
typedCopy
protected RegulatedAuthorization typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-