CH EPL (R5)
1.0.0-ballot - ballot
This page is part of the CH EPL (R5) (v1.0.0-ballot: DSTU 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions
| Official URL: http://fhir.ch/ig/ch-epl/StructureDefinition/ch-idmp-regulatedauthorization | Version: 1.0.0-ballot | |||
| Active as of 2025-05-22 | Computable Name: CHIDMPRegulatedAuthorization | |||
Copyright/Legal: CC0-1.0 |
||||
Profile of the RegulatedAuthorization resource for representing the market authorization of a (packaged) medicinal product.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | RegulatedAuthorization | IDMP RegulatedAuthorization dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() |
Σ | 0..* | Reference(IDMP MedicinalProductDefinition | IDMP PackagedProductDefinition | CH IDMP ManufacturedItemDefinition | IDMP Ingredient) | The product type, treatment, facility or activity that is being authorized ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
Σ | 0..1 | CodeableConcept | Overall type of this authorization, for example drug marketing approval, orphan drug designation Binding: CH - Authorisation Type (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-authorisation-type |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
Σ | 0..* | CodeableConcept | The territory in which the authorization has been granted Binding: JurisdictionValueSet (example): Jurisdiction codes ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:3166 | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: CH | |
![]() ![]() |
Σ | 0..1 | CodeableConcept | The status that is authorised e.g. approved. Intermediate states can be tracked with cases and applications Binding: CH SMC - Authorisation Status (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-authorisation-status |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-epl-foph-reimbursement-status |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
Σ | 0..1 | Reference(Organization) {c} | The organization that has been granted this authorization, by the regulator ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
Σ | 0..1 | Reference(Organization) {c} | The regulatory authority or authorizing body granting the authorization ele-1: All FHIR elements must have a @value or children |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| RegulatedAuthorization.type | required | ChAuthorisationTypeVS (a valid code from CH - Authorisation Type)http://fhir.ch/ig/ch-epl/ValueSet/ch-authorisation-typefrom this IG | |
| RegulatedAuthorization.region | example | Pattern: CHhttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | |
| RegulatedAuthorization.status | required | ChSMCAuthorisationStatusVS (a valid code from CH SMC - Authorisation Status)http://fhir.ch/ig/ch-epl/ValueSet/ch-SMC-authorisation-statusfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | RegulatedAuthorization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | RegulatedAuthorization | 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(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | RegulatedAuthorization | 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 | error | RegulatedAuthorization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | RegulatedAuthorization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from RegulatedAuthorization
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | RegulatedAuthorization | IDMP RegulatedAuthorization | |
![]() ![]() |
0..* | Reference(IDMP MedicinalProductDefinition | IDMP PackagedProductDefinition | CH IDMP ManufacturedItemDefinition | IDMP Ingredient) | The product type, treatment, facility or activity that is being authorized | |
![]() ![]() |
0..1 | CodeableConcept | Overall type of this authorization, for example drug marketing approval, orphan drug designation Binding: CH - Authorisation Type (required) | |
![]() ![]() ![]() |
0..1 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-authorisation-type | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() |
0..* | CodeableConcept | The territory in which the authorization has been granted Required Pattern: At least the following | |
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:3166 | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: CH | |
![]() ![]() |
0..1 | CodeableConcept | The status that is authorised e.g. approved. Intermediate states can be tracked with cases and applications Binding: CH SMC - Authorisation Status (required) | |
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-authorisation-status | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-epl-foph-reimbursement-status | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() |
0..1 | Reference(Organization) {c} | The organization that has been granted this authorization, by the regulator | |
![]() ![]() |
0..1 | Reference(Organization) {c} | The regulatory authority or authorizing body granting the authorization | |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| RegulatedAuthorization.type | required | ChAuthorisationTypeVS (a valid code from CH - Authorisation Type)http://fhir.ch/ig/ch-epl/ValueSet/ch-authorisation-typefrom this IG | |
| RegulatedAuthorization.status | required | ChSMCAuthorisationStatusVS (a valid code from CH SMC - Authorisation Status)http://fhir.ch/ig/ch-epl/ValueSet/ch-SMC-authorisation-statusfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | RegulatedAuthorization | IDMP RegulatedAuthorization | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | Business identifier for the authorization, typically assigned by the authorizing body | ||||
![]() ![]() |
Σ | 0..* | Reference(IDMP MedicinalProductDefinition | IDMP PackagedProductDefinition | CH IDMP ManufacturedItemDefinition | IDMP Ingredient) | The product type, treatment, facility or activity that is being authorized | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Overall type of this authorization, for example drug marketing approval, orphan drug designation Binding: CH - Authorisation Type (required) | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-authorisation-type | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
Σ | 0..1 | markdown | General textual supporting information | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | The territory in which the authorization has been granted Binding: JurisdictionValueSet (example): Jurisdiction codes Required Pattern: At least the following | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:3166 | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: CH | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | The status that is authorised e.g. approved. Intermediate states can be tracked with cases and applications Binding: CH SMC - Authorisation Status (required) | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-authorisation-status | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-epl-foph-reimbursement-status | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
Σ | 0..1 | dateTime | The date at which the current status was assigned | ||||
![]() ![]() |
Σ | 0..1 | Period | The 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 | ||||
![]() ![]() |
Σ | 0..* | CodeableReference(ClinicalUseDefinition) | Condition for which the use of the regulated product applies | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | The intended use of the product, e.g. prevention, treatment Binding: ProductIntendedUse (preferred): The overall intended use of a product. | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | The 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. | ||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) {c} | The organization that has been granted this authorization, by the regulator | ||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) {c} | The regulatory authority or authorizing body granting the authorization | ||||
![]() ![]() |
Σ | 0..* | Reference(DocumentReference) | Additional information or supporting documentation about the authorization | ||||
![]() ![]() |
Σ | 0..1 | BackboneElement | The 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) | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Identifier by which this case can be referenced | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The defining type of case Binding: RegulatedAuthorizationCaseType (example): The type of a case involved in an application. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The status associated with the case Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
Σ | 0..1 | Relevant date for this case | |||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Σ | 0..* | See case (RegulatedAuthorization) | Applications submitted to obtain a regulated authorization. Steps within the longer running case or procedure | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI |
| RegulatedAuthorization.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| RegulatedAuthorization.type | required | ChAuthorisationTypeVS (a valid code from CH - Authorisation Type)http://fhir.ch/ig/ch-epl/ValueSet/ch-authorisation-typefrom this IG | |
| RegulatedAuthorization.region | example | Pattern: CHhttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | |
| RegulatedAuthorization.status | required | ChSMCAuthorisationStatusVS (a valid code from CH SMC - Authorisation Status)http://fhir.ch/ig/ch-epl/ValueSet/ch-SMC-authorisation-statusfrom this IG | |
| RegulatedAuthorization.intendedUse | preferred | ProductIntendedUsehttp://hl7.org/fhir/ValueSet/product-intended-usefrom the FHIR Standard | |
| RegulatedAuthorization.basis | example | RegulatedAuthorizationBasishttp://hl7.org/fhir/ValueSet/regulated-authorization-basisfrom the FHIR Standard | |
| RegulatedAuthorization.case.type | example | RegulatedAuthorizationCaseTypehttp://hl7.org/fhir/ValueSet/regulated-authorization-case-typefrom the FHIR Standard | |
| RegulatedAuthorization.case.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-statusfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | RegulatedAuthorization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | RegulatedAuthorization | 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(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | RegulatedAuthorization | 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 | error | RegulatedAuthorization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | RegulatedAuthorization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from RegulatedAuthorization
Summary
Mandatory: 0 element(7 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | RegulatedAuthorization | IDMP RegulatedAuthorization dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() |
Σ | 0..* | Reference(IDMP MedicinalProductDefinition | IDMP PackagedProductDefinition | CH IDMP ManufacturedItemDefinition | IDMP Ingredient) | The product type, treatment, facility or activity that is being authorized ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
Σ | 0..1 | CodeableConcept | Overall type of this authorization, for example drug marketing approval, orphan drug designation Binding: CH - Authorisation Type (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-authorisation-type |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
Σ | 0..* | CodeableConcept | The territory in which the authorization has been granted Binding: JurisdictionValueSet (example): Jurisdiction codes ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:3166 | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: CH | |
![]() ![]() |
Σ | 0..1 | CodeableConcept | The status that is authorised e.g. approved. Intermediate states can be tracked with cases and applications Binding: CH SMC - Authorisation Status (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-authorisation-status |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-epl-foph-reimbursement-status |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
Σ | 0..1 | Reference(Organization) {c} | The organization that has been granted this authorization, by the regulator ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
Σ | 0..1 | Reference(Organization) {c} | The regulatory authority or authorizing body granting the authorization ele-1: All FHIR elements must have a @value or children |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| RegulatedAuthorization.type | required | ChAuthorisationTypeVS (a valid code from CH - Authorisation Type)http://fhir.ch/ig/ch-epl/ValueSet/ch-authorisation-typefrom this IG | |
| RegulatedAuthorization.region | example | Pattern: CHhttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | |
| RegulatedAuthorization.status | required | ChSMCAuthorisationStatusVS (a valid code from CH SMC - Authorisation Status)http://fhir.ch/ig/ch-epl/ValueSet/ch-SMC-authorisation-statusfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | RegulatedAuthorization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | RegulatedAuthorization | 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(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | RegulatedAuthorization | 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 | error | RegulatedAuthorization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | RegulatedAuthorization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from RegulatedAuthorization
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | RegulatedAuthorization | IDMP RegulatedAuthorization | |
![]() ![]() |
0..* | Reference(IDMP MedicinalProductDefinition | IDMP PackagedProductDefinition | CH IDMP ManufacturedItemDefinition | IDMP Ingredient) | The product type, treatment, facility or activity that is being authorized | |
![]() ![]() |
0..1 | CodeableConcept | Overall type of this authorization, for example drug marketing approval, orphan drug designation Binding: CH - Authorisation Type (required) | |
![]() ![]() ![]() |
0..1 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-authorisation-type | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() |
0..* | CodeableConcept | The territory in which the authorization has been granted Required Pattern: At least the following | |
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:3166 | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: CH | |
![]() ![]() |
0..1 | CodeableConcept | The status that is authorised e.g. approved. Intermediate states can be tracked with cases and applications Binding: CH SMC - Authorisation Status (required) | |
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-authorisation-status | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() |
0..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-epl-foph-reimbursement-status | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() |
0..1 | Reference(Organization) {c} | The organization that has been granted this authorization, by the regulator | |
![]() ![]() |
0..1 | Reference(Organization) {c} | The regulatory authority or authorizing body granting the authorization | |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| RegulatedAuthorization.type | required | ChAuthorisationTypeVS (a valid code from CH - Authorisation Type)http://fhir.ch/ig/ch-epl/ValueSet/ch-authorisation-typefrom this IG | |
| RegulatedAuthorization.status | required | ChSMCAuthorisationStatusVS (a valid code from CH SMC - Authorisation Status)http://fhir.ch/ig/ch-epl/ValueSet/ch-SMC-authorisation-statusfrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | RegulatedAuthorization | IDMP RegulatedAuthorization | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | Business identifier for the authorization, typically assigned by the authorizing body | ||||
![]() ![]() |
Σ | 0..* | Reference(IDMP MedicinalProductDefinition | IDMP PackagedProductDefinition | CH IDMP ManufacturedItemDefinition | IDMP Ingredient) | The product type, treatment, facility or activity that is being authorized | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Overall type of this authorization, for example drug marketing approval, orphan drug designation Binding: CH - Authorisation Type (required) | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-authorisation-type | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
Σ | 0..1 | markdown | General textual supporting information | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | The territory in which the authorization has been granted Binding: JurisdictionValueSet (example): Jurisdiction codes Required Pattern: At least the following | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:3166 | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: CH | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | The status that is authorised e.g. approved. Intermediate states can be tracked with cases and applications Binding: CH SMC - Authorisation Status (required) | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-authorisation-status | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-epl-foph-reimbursement-status | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
Σ | 0..1 | dateTime | The date at which the current status was assigned | ||||
![]() ![]() |
Σ | 0..1 | Period | The 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 | ||||
![]() ![]() |
Σ | 0..* | CodeableReference(ClinicalUseDefinition) | Condition for which the use of the regulated product applies | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | The intended use of the product, e.g. prevention, treatment Binding: ProductIntendedUse (preferred): The overall intended use of a product. | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | The 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. | ||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) {c} | The organization that has been granted this authorization, by the regulator | ||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) {c} | The regulatory authority or authorizing body granting the authorization | ||||
![]() ![]() |
Σ | 0..* | Reference(DocumentReference) | Additional information or supporting documentation about the authorization | ||||
![]() ![]() |
Σ | 0..1 | BackboneElement | The 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) | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Identifier by which this case can be referenced | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The defining type of case Binding: RegulatedAuthorizationCaseType (example): The type of a case involved in an application. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The status associated with the case Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
Σ | 0..1 | Relevant date for this case | |||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Σ | 0..* | See case (RegulatedAuthorization) | Applications submitted to obtain a regulated authorization. Steps within the longer running case or procedure | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI |
| RegulatedAuthorization.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| RegulatedAuthorization.type | required | ChAuthorisationTypeVS (a valid code from CH - Authorisation Type)http://fhir.ch/ig/ch-epl/ValueSet/ch-authorisation-typefrom this IG | |
| RegulatedAuthorization.region | example | Pattern: CHhttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | |
| RegulatedAuthorization.status | required | ChSMCAuthorisationStatusVS (a valid code from CH SMC - Authorisation Status)http://fhir.ch/ig/ch-epl/ValueSet/ch-SMC-authorisation-statusfrom this IG | |
| RegulatedAuthorization.intendedUse | preferred | ProductIntendedUsehttp://hl7.org/fhir/ValueSet/product-intended-usefrom the FHIR Standard | |
| RegulatedAuthorization.basis | example | RegulatedAuthorizationBasishttp://hl7.org/fhir/ValueSet/regulated-authorization-basisfrom the FHIR Standard | |
| RegulatedAuthorization.case.type | example | RegulatedAuthorizationCaseTypehttp://hl7.org/fhir/ValueSet/regulated-authorization-case-typefrom the FHIR Standard | |
| RegulatedAuthorization.case.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-statusfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | RegulatedAuthorization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | RegulatedAuthorization | 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(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | RegulatedAuthorization | 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 | error | RegulatedAuthorization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | RegulatedAuthorization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from RegulatedAuthorization
Summary
Mandatory: 0 element(7 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron