UnicomIG
0.1.0 - ci-build

UnicomIG, published by UNICOM. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/hl7-eu/unicom-ig and changes regularly. See the Directory of published versions

Resource Profile: Processing Profile - Marketing Authorisation

Official URL: http://unicom-project.eu/fhir/StructureDefinition/TransitionRegulatedAuthorization Version: 0.1.0
Active as of 2023-02-03 Computable Name: TransitionRegulatedAuthorization

Intermediate profile for processing PPL Marketing Authorisation (Regulated Authorization) data

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

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 0..*IdentifierMarketing authorisation number
.... system 0..1uriThe namespace for the identifier value
Required Pattern: http://ema.europa.eu/fhir/marketingAuthorizationNumber
... subject 0..*Reference(Processing Profile - Medicinal Product | Processing Profile - Packaged Product)Reference to the medicinal product or a single package, depending on how the MA has been issued
... type 0..1CodeableConceptOverall type of this authorization, for example drug marketing approval, orphan drug designation
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: https://spor.ema.europa.eu/v1/lists/220000000060
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 220000000061
..... display1..1stringRepresentation defined by the system
Fixed Value: Marketing Authorisation
... status 0..1CodeableConceptMarketing authorisation status
... statusDate 0..1dateTimeIssue/changing date of the marketing authorisation
... holder 0..1Reference(Processing Profile - Organization)The organization that has been granted this authorization, by the regulator

doco Documentation for this format
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
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierMarketing authorisation number
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... system Σ0..1uriThe namespace for the identifier value
Required Pattern: http://ema.europa.eu/fhir/marketingAuthorizationNumber
... type Σ0..1CodeableConceptOverall type of this authorization, for example drug marketing approval, orphan drug designation
Binding: RegulatedAuthorizationType (example): Overall type of this authorization.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: https://spor.ema.europa.eu/v1/lists/220000000060
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 220000000061
..... display1..1stringRepresentation defined by the system
Fixed Value: Marketing Authorisation
... region Σ0..1CodeableConceptThe territory in which the authorization has been granted
Binding: Jurisdiction ValueSet (example): Jurisdiction codes


... status Σ0..1CodeableConceptMarketing authorisation status
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... statusDate Σ0..1dateTimeIssue/changing date of the marketing authorisation
... holder Σ0..1Reference(Processing Profile - Organization)The organization that has been granted this authorization, by the regulator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
RegulatedAuthorization.identifier.userequiredIdentifierUse
RegulatedAuthorization.typeexamplePattern: 220000000061("Marketing Authorisation")
RegulatedAuthorization.regionexampleJurisdiction ValueSet
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.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').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 Σ0..*IdentifierMarketing authorisation number
.... 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)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ0..1uriThe namespace for the identifier value
Required Pattern: http://ema.europa.eu/fhir/marketingAuthorizationNumber
.... value Σ0..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 Σ0..*Reference(Processing Profile - Medicinal Product | Processing Profile - Packaged Product)Reference to the medicinal product or a single package, depending on how the MA has been issued
... type Σ0..1CodeableConceptOverall type of this authorization, for example drug marketing approval, orphan drug designation
Binding: RegulatedAuthorizationType (example): Overall type of this authorization.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: https://spor.ema.europa.eu/v1/lists/220000000060
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 220000000061
..... display1..1stringRepresentation defined by the system
Fixed Value: Marketing Authorisation
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... description Σ0..1markdownGeneral textual supporting information
... region Σ0..1CodeableConceptThe territory in which the authorization has been granted
Binding: Jurisdiction ValueSet (example): Jurisdiction codes


... status Σ0..1CodeableConceptMarketing authorisation status
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... statusDate Σ0..1dateTimeIssue/changing date of the marketing authorisation
... 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..1CodeableReference(ClinicalUseDefinition)Condition for which the use of the regulated product applies
... 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 Σ0..1Reference(Processing Profile - Organization)The organization that has been granted this authorization, by the regulator
... regulator Σ0..1Reference(Organization)The regulatory authority or authorizing body granting 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 / Code
RegulatedAuthorization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
RegulatedAuthorization.identifier.userequiredIdentifierUse
RegulatedAuthorization.identifier.typeextensibleIdentifier Type Codes
RegulatedAuthorization.typeexamplePattern: 220000000061("Marketing Authorisation")
RegulatedAuthorization.regionexampleJurisdiction ValueSet
RegulatedAuthorization.statuspreferredPublicationStatus
RegulatedAuthorization.intendedUsepreferredProductIntendedUse
RegulatedAuthorization.basisexampleRegulatedAuthorizationBasis
RegulatedAuthorization.case.typeexampleRegulatedAuthorizationCaseType
RegulatedAuthorization.case.statuspreferredPublicationStatus

Constraints

IdGradePath(s)DetailsRequirements
dom-r4bwarningRegulatedAuthorization.containedContaining new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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 0..*IdentifierMarketing authorisation number
.... system 0..1uriThe namespace for the identifier value
Required Pattern: http://ema.europa.eu/fhir/marketingAuthorizationNumber
... subject 0..*Reference(Processing Profile - Medicinal Product | Processing Profile - Packaged Product)Reference to the medicinal product or a single package, depending on how the MA has been issued
... type 0..1CodeableConceptOverall type of this authorization, for example drug marketing approval, orphan drug designation
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: https://spor.ema.europa.eu/v1/lists/220000000060
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 220000000061
..... display1..1stringRepresentation defined by the system
Fixed Value: Marketing Authorisation
... status 0..1CodeableConceptMarketing authorisation status
... statusDate 0..1dateTimeIssue/changing date of the marketing authorisation
... holder 0..1Reference(Processing Profile - Organization)The organization that has been granted this authorization, by the regulator

doco Documentation for this format

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
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierMarketing authorisation number
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... system Σ0..1uriThe namespace for the identifier value
Required Pattern: http://ema.europa.eu/fhir/marketingAuthorizationNumber
... type Σ0..1CodeableConceptOverall type of this authorization, for example drug marketing approval, orphan drug designation
Binding: RegulatedAuthorizationType (example): Overall type of this authorization.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: https://spor.ema.europa.eu/v1/lists/220000000060
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 220000000061
..... display1..1stringRepresentation defined by the system
Fixed Value: Marketing Authorisation
... region Σ0..1CodeableConceptThe territory in which the authorization has been granted
Binding: Jurisdiction ValueSet (example): Jurisdiction codes


... status Σ0..1CodeableConceptMarketing authorisation status
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... statusDate Σ0..1dateTimeIssue/changing date of the marketing authorisation
... holder Σ0..1Reference(Processing Profile - Organization)The organization that has been granted this authorization, by the regulator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
RegulatedAuthorization.identifier.userequiredIdentifierUse
RegulatedAuthorization.typeexamplePattern: 220000000061("Marketing Authorisation")
RegulatedAuthorization.regionexampleJurisdiction ValueSet
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.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').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 Σ0..*IdentifierMarketing authorisation number
.... 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)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ0..1uriThe namespace for the identifier value
Required Pattern: http://ema.europa.eu/fhir/marketingAuthorizationNumber
.... value Σ0..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 Σ0..*Reference(Processing Profile - Medicinal Product | Processing Profile - Packaged Product)Reference to the medicinal product or a single package, depending on how the MA has been issued
... type Σ0..1CodeableConceptOverall type of this authorization, for example drug marketing approval, orphan drug designation
Binding: RegulatedAuthorizationType (example): Overall type of this authorization.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: https://spor.ema.europa.eu/v1/lists/220000000060
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 220000000061
..... display1..1stringRepresentation defined by the system
Fixed Value: Marketing Authorisation
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... description Σ0..1markdownGeneral textual supporting information
... region Σ0..1CodeableConceptThe territory in which the authorization has been granted
Binding: Jurisdiction ValueSet (example): Jurisdiction codes


... status Σ0..1CodeableConceptMarketing authorisation status
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... statusDate Σ0..1dateTimeIssue/changing date of the marketing authorisation
... 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..1CodeableReference(ClinicalUseDefinition)Condition for which the use of the regulated product applies
... 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 Σ0..1Reference(Processing Profile - Organization)The organization that has been granted this authorization, by the regulator
... regulator Σ0..1Reference(Organization)The regulatory authority or authorizing body granting 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 / Code
RegulatedAuthorization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
RegulatedAuthorization.identifier.userequiredIdentifierUse
RegulatedAuthorization.identifier.typeextensibleIdentifier Type Codes
RegulatedAuthorization.typeexamplePattern: 220000000061("Marketing Authorisation")
RegulatedAuthorization.regionexampleJurisdiction ValueSet
RegulatedAuthorization.statuspreferredPublicationStatus
RegulatedAuthorization.intendedUsepreferredProductIntendedUse
RegulatedAuthorization.basisexampleRegulatedAuthorizationBasis
RegulatedAuthorization.case.typeexampleRegulatedAuthorizationCaseType
RegulatedAuthorization.case.statuspreferredPublicationStatus

Constraints

IdGradePath(s)DetailsRequirements
dom-r4bwarningRegulatedAuthorization.containedContaining new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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