Electronic Medicinal Product Information (ePI) FHIR Implementation Guide
1.0.0-ballot - STU Ballot International flag

This page is part of the Electronic Medicinal Product Information (ePI) FHIR Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR v5.0.0-ballot. . For a full list of available versions, see the Directory of published versions

Resource Profile: RegulatedAuthorizationUvEpi - Detailed Descriptions

Active as of 2022-12-04

Definitions for the RegulatedAuthorization-uv-epi resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. RegulatedAuthorization
2. RegulatedAuthorization.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..*
3. RegulatedAuthorization.identifier.system
Control1..?
BindingThe codes SHALL be taken from Type of Regulated Authorization; other codes may be used where these codes are not suitable
4. RegulatedAuthorization.identifier.value
Control1..?
5. RegulatedAuthorization.subject
Control10..*
TypeReference(MedicinalProductDefinitionUvEpi|MedicinalProductDefinition|BiologicallyDerivedProduct|NutritionProduct|PackagedProductDefinition|ManufacturedItemDefinition|Ingredient|SubstanceDefinition|DeviceDefinition|ResearchStudy|ActivityDefinition|PlanDefinition|ObservationDefinition|Practitioner|Organization|Location)
6. RegulatedAuthorization.type
BindingThe codes SHALL be taken from Regulated Authorization Type identifier systems; other codes may be used where these codes are not suitableFor example codes, see RegulatedAuthorizationType
7. RegulatedAuthorization.description
8. RegulatedAuthorization.region
BindingThe codes SHOULD be taken from ISO Country two letter codeFor example codes, see Jurisdiction ValueSet
9. RegulatedAuthorization.status
BindingThe codes SHOULD be taken from Authorization StatusThe codes SHOULD be taken from PublicationStatus
10. RegulatedAuthorization.indication
TypeCodeableReference(ClinicalUseDefinitionIndicationUvEpi|ClinicalUseDefinition)
11. RegulatedAuthorization.indication.reference
Control1..?
12. RegulatedAuthorization.holder
Control10..1
TypeReference(OrganizationUvEpi|Organization)
13. RegulatedAuthorization.regulator
TypeReference(OrganizationUvEpi|Organization)
14. RegulatedAuthorization.case
15. RegulatedAuthorization.case.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..?
16. RegulatedAuthorization.case.identifier.system
Control0..?
BindingThe codes SHOULD be taken from Case System Identifiers
17. RegulatedAuthorization.case.type
BindingThe codes SHOULD be taken from Regulatory Activity TypeFor example codes, see RegulatedAuthorizationCaseType
18. RegulatedAuthorization.case.status
BindingThe codes SHOULD be taken from General Status used across ePI resourcesThe codes SHOULD be taken from PublicationStatus

Guidance on how to interpret the contents of this table can be found here.

1. RegulatedAuthorization
Definition

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.

Control0..*
InvariantsDefined on this element
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (: text.`div`.exists())
2. RegulatedAuthorization.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. RegulatedAuthorization.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
4. RegulatedAuthorization.identifier
Definition

Business identifier for the authorization, typically assigned by the authorizing body.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..*
TypeIdentifier
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. RegulatedAuthorization.identifier.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. RegulatedAuthorization.identifier.system
Definition

Establishes the namespace for the value - that is, a absolute URL that describes a set values that are unique.

Control10..1
BindingThe codes SHALL be taken from Type of Regulated Authorization; other codes may be used where these codes are not suitableFor codes, see (unbound)
Typeuri
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Example
General:http://www.acme.com/identifiers/patient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. RegulatedAuthorization.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control10..1
Typestring
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Example
General:123456
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. RegulatedAuthorization.subject
Definition

The product type, treatment, facility or activity that is being authorized.

Control10..*
TypeReference(MedicinalProductDefinitionUvEpi|MedicinalProductDefinition|BiologicallyDerivedProduct|NutritionProduct|PackagedProductDefinition|ManufacturedItemDefinition|Ingredient|SubstanceDefinition|DeviceDefinition|ResearchStudy|ActivityDefinition|PlanDefinition|ObservationDefinition|Practitioner|Organization|Location)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. RegulatedAuthorization.type
Definition

Overall type of this authorization, for example drug marketing approval, orphan drug designation.

Control0..1
BindingThe codes SHALL be taken from Regulated Authorization Type identifier systems; other codes may be used where these codes are not suitableFor example codes, see RegulatedAuthorizationType
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. RegulatedAuthorization.description
Definition

General textual supporting information.

Control0..1
Typemarkdown
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. RegulatedAuthorization.region
Definition

The territory (e.g., country, jurisdiction etc.) in which the authorization has been granted.

Control0..*
BindingThe codes SHOULD be taken from ISO Country two letter codeFor example codes, see Jurisdiction ValueSet
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. RegulatedAuthorization.status
Definition

The status that is authorised e.g. approved. Intermediate states and actions can be tracked with cases and applications.

Control0..1
BindingThe codes SHOULD be taken from Authorization StatusThe codes SHOULD be taken from PublicationStatus
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. RegulatedAuthorization.indication
Definition

Condition for which the use of the regulated product applies.

Control0..*
TypeCodeableReference(ClinicalUseDefinitionIndicationUvEpi|ClinicalUseDefinition)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. RegulatedAuthorization.indication.reference
Definition

A reference to a resource the provides exact details about the information being referenced.

Control10..1
TypeReference
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. RegulatedAuthorization.holder
Definition

The organization that has been granted this authorization, by some authoritative body (the 'regulator').

Control10..1
TypeReference(OrganizationUvEpi|Organization)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. RegulatedAuthorization.regulator
Definition

The regulatory authority or authorizing body granting the authorization. For example, European Medicines Agency (EMA), Food and Drug Administration (FDA), Health Canada (HC), etc.

Control0..1
TypeReference(OrganizationUvEpi|Organization)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. RegulatedAuthorization.case
Definition

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).

Control0..1
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. RegulatedAuthorization.case.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
19. RegulatedAuthorization.case.type
Definition

The defining type of case.

Control0..1
BindingThe codes SHOULD be taken from Regulatory Activity TypeFor example codes, see RegulatedAuthorizationCaseType
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. RegulatedAuthorization.case.status
Definition

The status associated with the case.

Control0..1
BindingThe codes SHOULD be taken from General Status used across ePI resourcesThe codes SHOULD be taken from PublicationStatus
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here.

1. RegulatedAuthorization
Definition

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.

Control0..*
2. RegulatedAuthorization.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

3. RegulatedAuthorization.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Control0..1
TypeMeta
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. RegulatedAuthorization.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. RegulatedAuthorization.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages IETF language ta
Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. RegulatedAuthorization.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. RegulatedAuthorization.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

8. RegulatedAuthorization.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
9. RegulatedAuthorization.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. RegulatedAuthorization.identifier
Definition

Business identifier for the authorization, typically assigned by the authorizing body.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..*
TypeIdentifier
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. RegulatedAuthorization.identifier.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
12. RegulatedAuthorization.identifier.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on RegulatedAuthorization.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
13. RegulatedAuthorization.identifier.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. RegulatedAuthorization.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable
TypeCodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. RegulatedAuthorization.identifier.system
Definition

Establishes the namespace for the value - that is, a absolute URL that describes a set values that are unique.

Control1..1
BindingThe codes SHALL be taken from Type of Regulated Authorization; other codes may be used where these codes are not suitable
Typeuri
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Example
General:http://www.acme.com/identifiers/patient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. RegulatedAuthorization.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control1..1
Typestring
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Example
General:123456
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. RegulatedAuthorization.identifier.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. RegulatedAuthorization.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Organization)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. RegulatedAuthorization.subject
Definition

The product type, treatment, facility or activity that is being authorized.

Control1..*
TypeReference(MedicinalProductDefinitionUvEpi)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. RegulatedAuthorization.type
Definition

Overall type of this authorization, for example drug marketing approval, orphan drug designation.

Control0..1
BindingThe codes SHALL be taken from Regulated Authorization Type identifier systems; other codes may be used where these codes are not suitable
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. RegulatedAuthorization.description
Definition

General textual supporting information.

Control0..1
Typemarkdown
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. RegulatedAuthorization.region
Definition

The territory (e.g., country, jurisdiction etc.) in which the authorization has been granted.

Control0..*
BindingThe codes SHOULD be taken from ISO Country two letter code
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. RegulatedAuthorization.status
Definition

The status that is authorised e.g. approved. Intermediate states and actions can be tracked with cases and applications.

Control0..1
BindingThe codes SHOULD be taken from Authorization Status
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. RegulatedAuthorization.statusDate
Definition

The date at which the current status was assigned.

Control0..1
TypedateTime
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. RegulatedAuthorization.validityPeriod
Definition

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.

Control0..1
TypePeriod
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. RegulatedAuthorization.indication
Definition

Condition for which the use of the regulated product applies.

Control0..*
TypeCodeableReference(ClinicalUseDefinitionIndicationUvEpi)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. RegulatedAuthorization.indication.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
28. RegulatedAuthorization.indication.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on RegulatedAuthorization.indication.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
29. RegulatedAuthorization.indication.concept
Definition

A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology.

Control0..1
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. RegulatedAuthorization.indication.reference
Definition

A reference to a resource the provides exact details about the information being referenced.

Control1..1
TypeReference
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. RegulatedAuthorization.intendedUse
Definition

The intended use of the product, e.g. prevention, treatment, diagnosis.

Control0..1
BindingThe codes SHOULD be taken from ProductIntendedUse The overall intended use of a product
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. RegulatedAuthorization.basis
Definition

The legal or regulatory framework against which this authorization is granted, or other reasons for it.

Control0..*
BindingFor example codes, see RegulatedAuthorizationBasis A legal or regulatory framework against which an authorization is granted, or other reasons for it
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. RegulatedAuthorization.holder
Definition

The organization that has been granted this authorization, by some authoritative body (the 'regulator').

Control1..1
TypeReference(OrganizationUvEpi)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. RegulatedAuthorization.regulator
Definition

The regulatory authority or authorizing body granting the authorization. For example, European Medicines Agency (EMA), Food and Drug Administration (FDA), Health Canada (HC), etc.

Control0..1
TypeReference(OrganizationUvEpi)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. RegulatedAuthorization.attachedDocument
Definition

Additional information or supporting documentation about the authorization.

Control0..*
TypeReference(DocumentReference)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. RegulatedAuthorization.case
Definition

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).

Control0..1
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. RegulatedAuthorization.case.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
38. RegulatedAuthorization.case.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
39. RegulatedAuthorization.case.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
40. RegulatedAuthorization.case.identifier
Definition

Identifier by which this case can be referenced.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
41. RegulatedAuthorization.case.identifier.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
42. RegulatedAuthorization.case.identifier.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on RegulatedAuthorization.case.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
43. RegulatedAuthorization.case.identifier.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. RegulatedAuthorization.case.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable
TypeCodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. RegulatedAuthorization.case.identifier.system
Definition

Establishes the namespace for the value - that is, a absolute URL that describes a set values that are unique.

Control0..1
BindingThe codes SHOULD be taken from Case System Identifiers
Typeuri
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Example
General:http://www.acme.com/identifiers/patient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
46. RegulatedAuthorization.case.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control0..1
Typestring
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Example
General:123456
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
47. RegulatedAuthorization.case.identifier.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
48. RegulatedAuthorization.case.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Organization)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
49. RegulatedAuthorization.case.type
Definition

The defining type of case.

Control0..1
BindingThe codes SHOULD be taken from Regulatory Activity Type
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
50. RegulatedAuthorization.case.status
Definition

The status associated with the case.

Control0..1
BindingThe codes SHOULD be taken from General Status used across ePI resources
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
51. RegulatedAuthorization.case.date[x]
Definition

Relevant date for this case.

Control0..1
TypeChoice of: Period, dateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
52. RegulatedAuthorization.case.application
Definition

A regulatory submission from an organization to a regulator, as part of an assessing case. Multiple applications may occur over time, with more or different information to support or modify the submission or the authorization. The applications can be considered as steps within the longer running case or procedure for this authorization process.

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/RegulatedAuthorization#RegulatedAuthorization.case
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))