Electronic Medicinal Product Information (ePI) FHIR Implementation Guide
1.0.0 - trial-use International flag

This page is part of the Electronic Medicinal Product Information (ePI) FHIR Implementation Guide (v1.0.0: STU1) based on FHIR v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: RegulatedAuthorization (ePI)

Official URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/RegulatedAuthorization-uv-epi Version: 1.0.0
Standards status: Trial-use Maturity Level: 2 Computable Name: RegulatedAuthorizationUvEpi

RegulatedAuthorization (ePI)

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from RegulatedAuthorization

NameFlagsCard.TypeDescription & Constraintsdoco
.. RegulatedAuthorization 0..*RegulatedAuthorizationRegulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity e.g. Market Authorization for a Medicinal Product
... identifier 1..*IdentifierIdentifier assigned by the health authority to a single medicinal product
.... system 1..1uriThe namespace for the identifier value
.... value 1..1stringThe value that is unique
... subject 1..*Reference(MedicinalProductDefinition (ePI))The product type, treatment, facility or activity that is being authorized
... type 0..1CodeableConceptOverall type of this authorization, for example drug marketing approval, orphan drug designation.
... region 0..*CodeableConceptThe territory in which the authorization has been granted
Binding: ISO Country two letter code (preferred)
... status 0..1CodeableConceptThe current status of this authorization
... statusDate 0..1dateTimeThe date at which the current status was assigned.
... indication 0..*CodeableReference(ClinicalUseDefinition Indication (ePI))Reference to the Clinical Use Definition
.... reference 1..1Reference()Reference to a resource (by instance)
... holder 1..1Reference(Organization (ePI))The organization that has been granted this authorization, by the regulator
... regulator 0..1Reference(Organization (ePI))The regulatory authority or authorizing body granting the authorization
... case
.... identifier 0..1IdentifierIdentifier by which this case can be referenced.
.... type 0..1CodeableConceptThe defining type of case.
.... status 0..1CodeableConceptThe status associated with the case.
.... date[x] 0..1Period, dateTimeRelevant date for this case.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
RegulatedAuthorization.regionpreferredVsCountry
NameFlagsCard.TypeDescription & Constraintsdoco
.. RegulatedAuthorization 0..*RegulatedAuthorizationRegulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity e.g. Market Authorization for a Medicinal Product
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC1..1stringThe value that is unique
Example General: 123456
... subject Σ1..*Reference(MedicinalProductDefinition (ePI))The product type, treatment, facility or activity that is being authorized
... type Σ0..1CodeableConceptOverall type of this authorization, for example drug marketing approval, orphan drug designation.
Binding: RegulatedAuthorizationType (example): Overall type of this authorization.

... description Σ0..1markdownBrief description of the authorization
... region Σ0..*CodeableConceptThe territory in which the authorization has been granted
Binding: ISO Country two letter code (preferred)
... status Σ0..1CodeableConceptThe current status of this authorization
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... statusDate Σ0..1dateTimeThe date at which the current status was assigned.
... indication Σ0..*CodeableReference(ClinicalUseDefinition Indication (ePI))Reference to the Clinical Use Definition
.... reference Σ1..1Reference()Reference to a resource (by instance)
... holder Σ1..1Reference(Organization (ePI))The organization that has been granted this authorization, by the regulator
... regulator Σ0..1Reference(Organization (ePI))The regulatory authority or authorizing body granting the authorization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
RegulatedAuthorization.identifier.userequiredIdentifierUse
RegulatedAuthorization.typeexampleRegulatedAuthorizationType
RegulatedAuthorization.regionpreferredVsCountry
RegulatedAuthorization.statuspreferredPublicationStatus

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorRegulatedAuthorizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRegulatedAuthorizationIf 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(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorRegulatedAuthorizationIf 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-5errorRegulatedAuthorizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRegulatedAuthorizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. RegulatedAuthorization 0..*RegulatedAuthorizationRegulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity e.g. Market Authorization for a Medicinal Product
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..*IdentifierIdentifier assigned by the health authority to a single medicinal product
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... subject Σ1..*Reference(MedicinalProductDefinition (ePI))The product type, treatment, facility or activity that is being authorized
... type Σ0..1CodeableConceptOverall type of this authorization, for example drug marketing approval, orphan drug designation.
Binding: RegulatedAuthorizationType (example): Overall type of this authorization.

... description Σ0..1markdownBrief description of the authorization
... region Σ0..*CodeableConceptThe territory in which the authorization has been granted
Binding: ISO Country two letter code (preferred)
... status Σ0..1CodeableConceptThe current status of this authorization
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... statusDate Σ0..1dateTimeThe date at which the current status was assigned.
... validityPeriod Σ0..1PeriodThe time period in which the regulatory approval etc. is in effect, e.g. a Marketing Authorization includes the date of authorization and/or expiration date
... indication Σ0..*CodeableReference(ClinicalUseDefinition Indication (ePI))Reference to the Clinical Use Definition
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... concept Σ0..1CodeableConceptReference to a concept (by class)
.... reference Σ1..1Reference()Reference to a resource (by instance)
... intendedUse Σ0..1CodeableConceptThe intended use of the product, e.g. prevention, treatment
Binding: ProductIntendedUse (preferred): The overall intended use of a product.

... basis Σ0..*CodeableConceptThe legal/regulatory framework or reasons under which this authorization is granted
Binding: RegulatedAuthorizationBasis (example): A legal or regulatory framework against which an authorization is granted, or other reasons for it.


... holder Σ1..1Reference(Organization (ePI))The organization that has been granted this authorization, by the regulator
... regulator Σ0..1Reference(Organization (ePI))The regulatory authority or authorizing body granting the authorization
... attachedDocument Σ0..*Reference(DocumentReference)Additional information or supporting documentation about the authorization
... case Σ0..1BackboneElementThe case or regulatory procedure for granting or amending a regulated 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)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..1IdentifierIdentifier by which this case can be referenced.
.... type Σ0..1CodeableConceptThe defining type of case.
Binding: RegulatedAuthorizationCaseType (example): The type of a case involved in an application.

.... status Σ0..1CodeableConceptThe status associated with the case.
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

.... date[x] Σ0..1Relevant date for this case.
..... datePeriodPeriod
..... dateDateTimedateTime
.... application Σ0..*See case (RegulatedAuthorization)Applications submitted to obtain a regulated authorization. Steps within the longer running case or procedure

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
RegulatedAuthorization.languagerequiredAllLanguages
RegulatedAuthorization.identifier.userequiredIdentifierUse
RegulatedAuthorization.identifier.typeextensibleIdentifierTypeCodes
RegulatedAuthorization.typeexampleRegulatedAuthorizationType
RegulatedAuthorization.regionpreferredVsCountry
RegulatedAuthorization.statuspreferredPublicationStatus
RegulatedAuthorization.intendedUsepreferredProductIntendedUse
RegulatedAuthorization.basisexampleRegulatedAuthorizationBasis
RegulatedAuthorization.case.typeexampleRegulatedAuthorizationCaseType
RegulatedAuthorization.case.statuspreferredPublicationStatus

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from RegulatedAuthorization

NameFlagsCard.TypeDescription & Constraintsdoco
.. RegulatedAuthorization 0..*RegulatedAuthorizationRegulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity e.g. Market Authorization for a Medicinal Product
... identifier 1..*IdentifierIdentifier assigned by the health authority to a single medicinal product
.... system 1..1uriThe namespace for the identifier value
.... value 1..1stringThe value that is unique
... subject 1..*Reference(MedicinalProductDefinition (ePI))The product type, treatment, facility or activity that is being authorized
... type 0..1CodeableConceptOverall type of this authorization, for example drug marketing approval, orphan drug designation.
... region 0..*CodeableConceptThe territory in which the authorization has been granted
Binding: ISO Country two letter code (preferred)
... status 0..1CodeableConceptThe current status of this authorization
... statusDate 0..1dateTimeThe date at which the current status was assigned.
... indication 0..*CodeableReference(ClinicalUseDefinition Indication (ePI))Reference to the Clinical Use Definition
.... reference 1..1Reference()Reference to a resource (by instance)
... holder 1..1Reference(Organization (ePI))The organization that has been granted this authorization, by the regulator
... regulator 0..1Reference(Organization (ePI))The regulatory authority or authorizing body granting the authorization
... case
.... identifier 0..1IdentifierIdentifier by which this case can be referenced.
.... type 0..1CodeableConceptThe defining type of case.
.... status 0..1CodeableConceptThe status associated with the case.
.... date[x] 0..1Period, dateTimeRelevant date for this case.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
RegulatedAuthorization.regionpreferredVsCountry

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RegulatedAuthorization 0..*RegulatedAuthorizationRegulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity e.g. Market Authorization for a Medicinal Product
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC1..1stringThe value that is unique
Example General: 123456
... subject Σ1..*Reference(MedicinalProductDefinition (ePI))The product type, treatment, facility or activity that is being authorized
... type Σ0..1CodeableConceptOverall type of this authorization, for example drug marketing approval, orphan drug designation.
Binding: RegulatedAuthorizationType (example): Overall type of this authorization.

... description Σ0..1markdownBrief description of the authorization
... region Σ0..*CodeableConceptThe territory in which the authorization has been granted
Binding: ISO Country two letter code (preferred)
... status Σ0..1CodeableConceptThe current status of this authorization
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... statusDate Σ0..1dateTimeThe date at which the current status was assigned.
... indication Σ0..*CodeableReference(ClinicalUseDefinition Indication (ePI))Reference to the Clinical Use Definition
.... reference Σ1..1Reference()Reference to a resource (by instance)
... holder Σ1..1Reference(Organization (ePI))The organization that has been granted this authorization, by the regulator
... regulator Σ0..1Reference(Organization (ePI))The regulatory authority or authorizing body granting the authorization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
RegulatedAuthorization.identifier.userequiredIdentifierUse
RegulatedAuthorization.typeexampleRegulatedAuthorizationType
RegulatedAuthorization.regionpreferredVsCountry
RegulatedAuthorization.statuspreferredPublicationStatus

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorRegulatedAuthorizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRegulatedAuthorizationIf 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(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorRegulatedAuthorizationIf 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-5errorRegulatedAuthorizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRegulatedAuthorizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RegulatedAuthorization 0..*RegulatedAuthorizationRegulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity e.g. Market Authorization for a Medicinal Product
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..*IdentifierIdentifier assigned by the health authority to a single medicinal product
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... subject Σ1..*Reference(MedicinalProductDefinition (ePI))The product type, treatment, facility or activity that is being authorized
... type Σ0..1CodeableConceptOverall type of this authorization, for example drug marketing approval, orphan drug designation.
Binding: RegulatedAuthorizationType (example): Overall type of this authorization.

... description Σ0..1markdownBrief description of the authorization
... region Σ0..*CodeableConceptThe territory in which the authorization has been granted
Binding: ISO Country two letter code (preferred)
... status Σ0..1CodeableConceptThe current status of this authorization
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... statusDate Σ0..1dateTimeThe date at which the current status was assigned.
... validityPeriod Σ0..1PeriodThe time period in which the regulatory approval etc. is in effect, e.g. a Marketing Authorization includes the date of authorization and/or expiration date
... indication Σ0..*CodeableReference(ClinicalUseDefinition Indication (ePI))Reference to the Clinical Use Definition
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... concept Σ0..1CodeableConceptReference to a concept (by class)
.... reference Σ1..1Reference()Reference to a resource (by instance)
... intendedUse Σ0..1CodeableConceptThe intended use of the product, e.g. prevention, treatment
Binding: ProductIntendedUse (preferred): The overall intended use of a product.

... basis Σ0..*CodeableConceptThe legal/regulatory framework or reasons under which this authorization is granted
Binding: RegulatedAuthorizationBasis (example): A legal or regulatory framework against which an authorization is granted, or other reasons for it.


... holder Σ1..1Reference(Organization (ePI))The organization that has been granted this authorization, by the regulator
... regulator Σ0..1Reference(Organization (ePI))The regulatory authority or authorizing body granting the authorization
... attachedDocument Σ0..*Reference(DocumentReference)Additional information or supporting documentation about the authorization
... case Σ0..1BackboneElementThe case or regulatory procedure for granting or amending a regulated 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)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..1IdentifierIdentifier by which this case can be referenced.
.... type Σ0..1CodeableConceptThe defining type of case.
Binding: RegulatedAuthorizationCaseType (example): The type of a case involved in an application.

.... status Σ0..1CodeableConceptThe status associated with the case.
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

.... date[x] Σ0..1Relevant date for this case.
..... datePeriodPeriod
..... dateDateTimedateTime
.... application Σ0..*See case (RegulatedAuthorization)Applications submitted to obtain a regulated authorization. Steps within the longer running case or procedure

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
RegulatedAuthorization.languagerequiredAllLanguages
RegulatedAuthorization.identifier.userequiredIdentifierUse
RegulatedAuthorization.identifier.typeextensibleIdentifierTypeCodes
RegulatedAuthorization.typeexampleRegulatedAuthorizationType
RegulatedAuthorization.regionpreferredVsCountry
RegulatedAuthorization.statuspreferredPublicationStatus
RegulatedAuthorization.intendedUsepreferredProductIntendedUse
RegulatedAuthorization.basisexampleRegulatedAuthorizationBasis
RegulatedAuthorization.case.typeexampleRegulatedAuthorizationCaseType
RegulatedAuthorization.case.statuspreferredPublicationStatus

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron